stringbuf: clarify license

[linenoise.git] / README.markdown

diff --git a/README.markdown b/README.markdown
index d474059211b03857c737de774e9f458206f67759..70cba8b32eb3364d6d96e88f45883a91d789eca0 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -1,5 +1,36 @@
 # Linenoise
 
+## What's different in this fork?
+
+- Win32 console
+- full utf8 support (what about utf8 on windows)
+- insert control characters
+- no hints yet
+- now with multiline
+
+## How do I include linenoise line editing support in my application?
+
+From the Makefile:
+
+  linenoise-ship.c simplifies delivery of linenoise support
+
+  simple copy linenoise-ship.c to linenoise.c in your application, and also linenoise.h
+
+  * If you want win32 support, also copy linenoise-win32.c
+  * If you never want to support utf-8, you can omit utf8.h and utf8.c
+
+To enable utf-8 support, define USE_UTF8
+
+## Where do I get it?
+
+Get it here: [https://github.com/msteveb/linenoise](https://github.com/msteveb/linenoise)
+
+--------------------------------------------------------
+
+## Original README below
+
+Can a line editing library be 20k lines of code?
+
 A minimal, zero-config, BSD licensed, readline replacement.
 
 News: linenoise now includes minimal completion support, thanks to Pieter Noordhuis (@pnoordhuis).