Fixes & readme

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
index 052d209..b874492 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,33 @@
 # iClean
 Interactive Clean
+
+This module allows you to execute Clean commands interactively, similar to GHCi or the Python shell. Functionality is very limited. In particular there is **no memory**, so you're restricted to one-liners.
+
+## Example session
+
+    $ ./iclean
+    > [1,2,3,4]
+    [1,2,3,4]
+    > map toString [1..10]
+    ["1","2","3","4","5","6","7","8","9","10"]
+    > [Ctrl-D]
+    $
+
+## Installation
+
+    make iclean
+
+## Running
+Either
+
+    ./iclean
+
+or
+
+    make run
+
+## Todo
+
+ * Implement memory (e.g. to first declare a function / constant and then use it)
+ * Commands memory (scroll through previous commands with arrow keys)
+ * Imports