From 84bf6abe45c154d56485ccf62a23e551e3657326 Mon Sep 17 00:00:00 2001
From: Jan Maximilian Michal <j.michal@stud.uni-goettingen.de>
Date: Tue, 13 Dec 2016 01:24:45 +0000
Subject: [PATCH] Updated README.md

---
 README.md | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 36078d8..8584eb4 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,29 @@
 # Hallgrim - an ILIAS task generator in Python
 
+## Installation
+
+```
+git clone https://gitlab.gwdg.de/j.michal/ilias-generator.git
+cd ilias-generator
+pip install -e .
+```
+
 ## Usage
 
-Invoke the script with `python3 grim.py -h` in order to see usage. Currently
-many features are not yet implemented. Single and Multiple Choice questions
-can be generated also in parametrized form.
+After the install just invoke `hallgrim -h` to see usage. The directory hallgrim
+is invoked in, should contain a `config.ini`.
 
-Example scripts can be found in `scripts/examples/`.
+Example scripts can be found [in a seperate repository](https://gitlab.gwdg.de/j.michal/ilias-scripts).
 
 ### Dependencies
 
-- `pip install mistune`
-- `pip install pygments`
-- `pip install requests`
-- `pip install requests_toolbelt`
+`pip` will try to install them automatically. If you can figure out how to
+replace requests with the native urllib3 - you are welcome to help.
+
+- `mistune`
+- `pygments`
+- `requests`
+- `requests_toolbelt`
 
 ### TODO
 
-- 
GitLab