Merge pull request #3 from dopefishh/standard-maybe

[CleanReadLine.git] / README.md

diff --git a/README.md b/README.md
index 1f12c6e..69fc07a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-Clean readline Version 0.2
+Clean readline Version 0.4
 ==========================
 
 ReadLine is a Clean library that allows interactive console programs to use the
@@ -24,8 +24,18 @@ All functions try to resemble the original
 [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.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.
+  - Fixed issue #1
+  - History state can now be written as well as read
 - 0.2 (2016-01-25)
   - History file operations added
   - EOF is now properly handled
@@ -35,11 +45,12 @@ functions as close as possible
 
 ###Todo
 
-- Access to the history datastructure
-- Access to the current location
+- 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
-- Embed the readline library in the object files in such a way that no special
-  compiler flag is needed.
 - Control over tabcompletion, right now it completes on filenames.
 - Check possibilities for Windows/Mac