Merge pull request #3 from dopefishh/standard-maybe

[CleanReadLine.git] / README.md

diff --git a/README.md b/README.md
index 9e217eb..69fc07a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-Clean readline Version 0.3
+Clean readline Version 0.4
 ==========================
 
 ReadLine is a Clean library that allows interactive console programs to use the
@@ -17,16 +17,20 @@ make
 ```
 
 When you want to use the library in your program you should compile with the
-`-l /usr/lib/libreadline.so` linker flag
+`-l -lreadline` 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
 
+*Please note that some functions will crash if `usingHistory` is not called*
+
 ###Changelog
 
-- 0.3 (2016-01-26)
+- 0.5 (2016-01-28)
+  - All API functions implemented, requires some testing
+- 0.4 (2016-01-26)
   - Better build mechanism
   - Information about the history list functions implemented, not thoroughly
     tested though.
@@ -41,6 +45,10 @@ functions as close as possible
 
 ###Todo
 
+- Find a way to set readline variables
+- Check all functions if more maybe's are needed to handle NULL
+       - For example replace history
+- Implement history expansion functions
 - Use builtin Maybe if available, otherwise fall back on own Maybe
 - Complete history api implementation
 - Control over tabcompletion, right now it completes on filenames.