update readme

TsaoLun · Oct 5, 2021 · 8c87c06 · 8c87c06
1 parent 7a582c6
commit 8c87c06
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,12 +15,15 @@
 **/.DS_Store
 **/logs
 
-# ignore adhoc test code
-**/adhoc
-
 # gitlab ci
 .cache
 
 # vim auto backup file
 *~
 !OWNERS
+
+# corpus files
+data
+**/*.corpus.json
+**/*.gob
+**/stopwords.txt
diff --git a/README.md b/README.md
@@ -1,6 +1,16 @@
 # chatbot
 A fast responsive chatter bot written in Go.
 
-Docs will be written soon.
+* cli
+  * train
+
+    train conversations into corpus format, `.gob` files.
+
+  * ask
+
+    a client tool to chat
+
+    * `-v` verbose mode
+    * `-c` the trained corpus file
 
 Thanks to [ChatterBot](https://github.com/gunthercox/ChatterBot).