docs: Add basic docs to README

sikalabs · Aug 3, 2021 · 9f49162 · 9f49162
1 parent 9ee2a0c
commit 9f49162
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,33 @@
 # slut: SikaLabs UTils
+
+## Install
+
+### Mac
+
+```
+brew install sikalabs/tap/slut
+```
+
+### Autocomplete
+
+See: `slut completion`
+
+#### Bash
+
+```
+source <(slut completion bash)
+```
+
+## CLI Usage
+
+### Generated CLI Docs on Github
+
+See: <https://github.com/sikalabs/slut-cli-docs/blob/master/slut.md#slut>
+
+## Generate CLI Docs
+
+Generate Markdown CLI docs to `./cobra-docs`
+
+```
+slut generate-docs
+```