From cf5fd6362a43f187c20d221dd3ffd920cd67d880 Mon Sep 17 00:00:00 2001
From: Sean Davis <smd.seandavis@gmail.com>
Date: Sat, 1 Jun 2019 20:11:37 -0400
Subject: [PATCH] New README.md

---
 README    | 38 --------------------------------------
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 51 insertions(+), 38 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index ee4f104..0000000
--- a/README
+++ /dev/null
@@ -1,38 +0,0 @@
-Mugshot is a lightweight user configuration utility that allows you to easily 
-update personal user details. This includes:
-  - Linux profile image: ~/.face
-  - User details stored in /etc/passwd (used by finger)
-  - Pidgin buddy icon
-  - LibreOffice user details
-  
-Dependencies: 
-    chfn, 
-    python3-gi, 
-    python3-pexpect, 
-    python3-dbus, 
-    python3-cairo
-Optional: 
-    # Webcam support
-    gstreamer1.0-plugins-good,
-    gstreamer1.0-tools,
-    gir1.2-cheese-3.0,
-    gir1.2-gtkclutter-1.0,
-    #Profile photos
-    gnome-control-center-data
-
-Please report comments, suggestions and bugs to:
-    Sean Davis <smd.seandavis@gmail.com>
-    
-Check for new versions at:
-    https://launchpad.net/mugshot
-
-
-NOTE: If you get the following error:
-
-(mugshot:22748): GLib-GIO-ERROR **: Settings schema 'apps.mugshot' is not installed
-
-be sure to copy data/glib-2.0/schemas/apps.mugshot.gschema.xml to either:
-/usr/share/glib-2.0/schemas, or
-/usr/local/share/glib-2.0/schemas
-
-and run glib-compile-schemas on that directory before running.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..173bc1a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# Mugshot
+**Mugshot** is a lightweight user configuration utility for Linux designed for simplicity and ease of use. Quickly update your personal profile and sync your updates across applications.
+
+## Features
+ - Update your user profile image (~/.face and AccountService)
+ - Update user details stored in /etc/passwd (used by *finger* and other desktop applications)
+ - (Optionally) sync your profile image to your *Pidgin* buddy icon
+ - (Optionally) sync your user details to *LibreOffice*
+
+## Dependencies
+
+### Required
+ - chfn
+ - python3-cairo
+ - python3-dbus
+ - python3-gi
+ - python3-pexpect
+
+### Optional (for webcam support)
+ - gstreamer1.0-plugins-good
+ - gstreamer1.0-tools
+ - gir1.2-cheese-3.0
+ - gir1.2-gtkclutter-1.0
+
+## Installation
+
+### Debian, Ubuntu, and Derivatives
+    sudo apt update
+    sudo apt install mugshot
+
+### From Source
+    sudo python3 setup.py install
+    sudo glib-compile-schemas /usr/share/glib-2.0/schemas
+
+### Other Supported Methods
+Please submit a bug report or pull request to include additional methods of installation!
+
+## Links
+Check for new versions or report comments, suggestions and bugs on [GitHub](https://github.com/bluesabre/mugshot)
+
+## Troubleshooting
+If you see the following error:
+
+    (mugshot:22748): GLib-GIO-ERROR **: Settings schema 'apps.mugshot' is not installed
+
+Be sure to copy data/glib-2.0/schemas/apps.mugshot.gschema.xml to either:
+
+ - /usr/share/glib-2.0/schemas, or
+ - /usr/local/share/glib-2.0/schemas
+
+and run glib-compile-schemas on that directory before running **Mugshot**.