expanding implemented

[CleanReadLine.git] / README.md

diff --git a/README.md b/README.md
index 9e217eb..dbbdeff 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,13 +17,15 @@ 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)
@@ -41,6 +43,9 @@ functions as close as possible
 
 ###Todo
 
+- 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.