write README.md

README.md

@@ -1,2 +1,55 @@
-# nextword
-Suggests the next English word.
+# Nextword
+Predict a next English word.
+
+![powa](img/terminal.gif)
+
+## Install
+
+0. (Recommended) Star this repository (｀･ω･´)★
+
+1. [**IMPORTANT**] Install [Nextword-data (https://github.com/high-moctane/nextword-data)](https://github.com/high-moctane/nextword-data)
+
+2. Install this program (You need Go language compiler).
+
+    ```bash
+    $ go get -u github.com/high-moctane/nextword
+    ```
+
+## Usage
+
+```
+$ nextword -h
+Nextword prints the most likely English words that follow the stdin sentence.
+
+Usage of /Users/moctane/go/bin/nextword:
+  -Greedy
+    	show as many result as possible
+  -candidate-num int
+    	max candidates number (default 100)
+  -data string
+    	path to the data directory (default "/Users/moctane/Assets/nextword-data")
+  -h	show this message
+  -v	show version
+
+You need to install nextword-data and set "NEXTWORD_DATA_PATH" environment variable.
+It available at https://github.com/high-moctane/nextword-data
+
+The result depends on whether the input string ends with a space character.
+If the string does not end with a space, nextword will print candidate words which
+begin the last word in the sentence.
+
+Example:
+	input:  "Alice was "
+	output: "not a the in still born very so to beginning too at sitting ..."
+
+	input:  "Alice w"
+	output: "was would were went with will who wrote when wants ..."
+```
+
+## Contributing
+
+Please feel free to send pull requests.
+
+## License
+
+MIT