From 25447666a04d76543eea60b24d5f6a93cfc7994e Mon Sep 17 00:00:00 2001
From: Cheney <me@chenye.org>
Date: Wed, 23 Sep 2015 13:55:53 +0800
Subject: [PATCH] add doc

---
 doc.go | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 doc.go

diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..656d6ca
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,20 @@
+// Readline is a pure go implementation for GNU-Readline kind library.
+//
+// WHY: Readline will support most of features which GNU Readline is supported, and provide a pure go environment and a MIT license.
+//
+// example:
+// 	rl, err := readline.New("> ")
+// 	if err != nil {
+// 		panic(err)
+// 	}
+// 	defer rl.Close()
+//
+// 	for {
+// 		line, err := rl.Readline()
+// 		if err != nil { // io.EOF
+// 			break
+// 		}
+// 		println(line)
+// 	}
+//
+package readline