New README (with building notes)

- Add more info about the project
- Add installation/building instructions
- Specify what license the project is under

Signed-off-by: Cameron Katri <me@cameronkatri.com>

diff --git a/README.md b/README.md
index 5a53b9e3ef7fc43c4e79fee6900176ff129f1bb9..8ad3d918478b16212861cec82aa7f18501effd7d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,31 @@
 # snaprestore
 
-`Usage: snaprestore [volume] [snapshot]`
+> snaprestore [volume] [snapshot]
 
-Fair amount of testing  
-Renames snapshot to original name  
-Removes jailbreak apps from icon cache  
-Clean up `/var`
-Works on any jailbreak (hopefully)
+Easily restore rootfs from the command line.
+
+## Features
+
+* Fair amount of testing
+* Cleans up `/var`
+* Renames snapshot to original name
+* Removes jailbreak apps from icon cache
+* Works on any jailbreak *(hopefully)*
+
+## Installation
+
+A build of `snaprestore` is available on [Procursus](https://github.com/ProcursusTeam/Procursus), which you can install if your device is already setup with an instance of the build system.
+
+Alternatively, you can compile `snaprestore` on your device using Make.
+
+    make install
+
+If you need a Debian package for later use, use the following command
+
+    make package
+
+Check out the [Makefile](Makefile) to see what options you might need to setup for `snaprestore` to build properly.
+
+## License
+
+`snaprestore` has been licensed under the [BSD-2 Clause License](LICENCE).