added readme.md

README.md

@@ -0,0 +1,75 @@
+# Just Another Line Editor
+
+or jale.nim
+
+# Note
+
+This is a new (and very immature) alternative to other
+line editors such as linenoise (see rdstdin in the nim
+standard library) or nimline (https://github.com/h3rald/nimline). Currently you probably want to use either of
+those because this is a wip.
+
+# Building
+
+Have nim (tested on 1.4.2, x86_64 gnu/linux) installed.
+
+```
+nim c main
+```
+
+You should enter a temporary testing prompt, which you
+can quit with ctrl+c.
+Pressing enter when the last line is empty submits
+the output.
+
+# Features
+
+- multiline support
+- easily add new keybindings (using templates)
+- very customizable (even inserting characters is a keybinding that's optional)
+
+# Example usage
+
+```nim
+# for now, from the same directory where it's cloned
+# import the line editor
+import editor
+# import the default keybindings for basic stuff
+# like arrow key movement or inserting characters
+import defaults
+# import helper templates for adding custom key or
+# event bindings
+import templates
+
+# create the line editor
+let e = newLineEditor()
+# set its prompt to something
+e.prompt = "> "
+# add the default keybindings
+e.populateDefaults()
+
+var printOutput = true
+e.bindKey("ctrl+b"):
+	printOutput = false
+
+let input = e.read()
+if printOutput:
+	echo "output:"
+	echo input
+```
+
+Also see main.nim if the above example does not suffice,
+and look at defaults.nim for many binding examples.
+Look at multiline.nim's procs and editor.nim's 
+LineEditor type for an "API". It's wip, docs will 
+improve if it ever gets more stable.
+
+# Missing features
+
+Note: they won't be missing forever hopefully.
+
+- No utf-8
+- No tab support
+- No syntax highlighting support
+- Does not support windows
+

main.nim

@@ -15,4 +15,4 @@ e.populateDefaults()
 while keep:
   let input = e.read()
   echo "output:<" & input.replace("\n", "\\n") & ">"
-  
+