update readme

[CleanReadLine.git] / README.md

diff --git a/README.md b/README.md
index c50a825..779067d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-Clean readline Version 0.1
+Clean readline Version 0.3
 ==========================
 
 ReadLine is a Clean library that allows interactive console programs to use the
@@ -19,14 +19,27 @@ make
 When you want to use the library in your program you should compile with the
 `-l /usr/lib/libreadline.so` linker flag
 
+All functions try to resemble the original
+[readline](http://cnswww.cns.cwru.edu/php/chet/readline/readline.html) and 
+[history](http://cnswww.cns.cwru.edu/php/chet/readline/history.html) api
+functions as close as possible
+
+###Changelog
+
+- 0.3 (2016-01-25)
+  - History state can now be written as well as read
+- 0.2 (2016-01-25)
+  - History file operations added
+  - EOF is now properly handled
+- 0.1 (2016-01-25)
+  - Readline is working
+  - History works but no control over it
+
 ###Todo
 
-- Test how the library reacts on non terminal stdin and EOF
+- Complete history api implementation
 - Embed the readline library in the object files in such a way that no special
   compiler flag is needed.
-- Control over history, right now entries are added automatically to the
-  history when the boolean flag is on. It would be nice to be able to add
-  custom entries.
 - Control over tabcompletion, right now it completes on filenames.
 - Check possibilities for Windows/Mac