re
/
readline
forked from mirror/readline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add doc

This commit is contained in:
Cheney 2015-09-23 13:55:53 +08:00
parent 3c4b5dd53d
commit 25447666a0
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc.go Normal file
View File

@ -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