add readme

1 files changed, 21 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..64eee1c
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,21 @@
+# complete
+
+WIP
+
+a tool for bash writing bash completion in go.
+
+## example: `go` command bash completion
+
+Install in you home directory:
+
+```
+go build -o ~/.bash_completion/go ./gocomplete
+echo "complete -C ~/.bash_completion/go go" >> ~/.bashrc
+```
+
+Or, install in the root directory:
+
+```
+sudo go build -o /etc/bash_completion.d/go ./gocomplete
+```
+