From fa8f7cbb55541b91104751f0c14596b00af71167 Mon Sep 17 00:00:00 2001
From: EsGeh <SamuelGfroerer@googlemail.com>
Date: Wed, 27 Nov 2019 10:06:20 +0100
Subject: [PATCH] added usage example, documented in the README

---
 README.md                 | 24 ++++++++++++++++++++++--
 example/dependencies.conf |  5 +++++
 2 files changed, 27 insertions(+), 2 deletions(-)
 create mode 100644 example/dependencies.conf

diff --git a/README.md b/README.md
index 1df3d26..f2e78e0 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,33 @@
 # git_deps_py
 
-manage dependencies between git repositories (poor mans "git submodules")
+manage dependencies between git repositories (lightweight "git submodules")
 
 # Status
 
-- TODO
+- experimental
 
 # Features
 
 - Standardized way how to document and manage dependencies to other repositories
 - For each dependency an init script can be specified
 - Reasonable behaviour of indirect dependencies (e.g. avoid redundant downloads and init scripts)
+
+# Usage Example
+
+consider `example` your git project with dependencies. Lets cd into it:
+
+	$ cd example
+	$ ls
+	> dependencies.conf
+
+`dependencies.conf` specifies the dependencies.
+Open it in your favourite editor to see how it is constructed.
+Let's install the dependencies:
+
+	$ ../get_deps.py
+
+This will clone the git repositories specified in `dependencies.conf` into a folder (default: `./dependencies/`).
+Also, for each dependency the specified versions (git hash) are "checked out" and the init script (if specified) is run.
+To see default settings and learn the command line arguments, run:
+
+	$ ../get_deps.py --help
diff --git a/example/dependencies.conf b/example/dependencies.conf
new file mode 100644
index 0000000..8f16837
--- /dev/null
+++ b/example/dependencies.conf
@@ -0,0 +1,5 @@
+[test]
+
+uri = https://github.molgen.mpg.de/EditionOpenAccess/EOASkripts.git
+hash = 5bf3c45a5c0b822eb425038c2ceb14722694dbe0
+init = scripts/init.py