From 555e0e7696231dab66180f6f82305b2d6211d379 Mon Sep 17 00:00:00 2001
From: Jan Philipp Timme <jan.philipp@timme.it>
Date: Tue, 8 Dec 2015 01:16:11 +0100
Subject: [PATCH] Add a little more documentation on how to use GPGFS.

---
 README.md        | 19 +++++++++++++++++--
 requirements.txt |  2 ++
 2 files changed, 19 insertions(+), 2 deletions(-)
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index 830c760..7ab0aec 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,29 @@
 
 GPG encryption for synchronized folders.
 
+    Usage: gpgfs <gpg_keyid> <encrypted_root> <mountpoint>
+
+
+gpg_keyid: The identity of the gpg key to use. (See gpg -K)
+
+encrypted_root: Path to folder where to store the encrypted data in.
+
+mountpoint: Where to mount the filesystem.
+
 # File structure
 
-    gpgfs/a/b
+This represents the structure GPGFS will use to store the encrypted data on disk.
+
     gpgfs/index
+    gpgfs/a/b
 
 # Dependencies
 
-    pip install python-gnupg fusepy
+GPGFS needs python3 and fuse support to run.
+
+You can install the python dependencies using pip: (using a virtualenv may be helpful)
+
+    pip install -r requirements.txt
 
 # Test suites
 
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..13ec477
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+python-gnupg
+fusepy