master Update readme with specifications and add demo gif (#279)

- Signed-off-by: Denis Vieira <denisvieira05@gmail.com>
ZupIT · Oct 15, 2020 · f236093 · f236093
1 parent a2c7ce0
commit f236093
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/github/search/handbook/README.md b/github/search/handbook/README.md
@@ -1,11 +1,34 @@
-# Github search handbook
+# Github Search Handbook
 
-## command
 
+## Premisses
+
+- [Golang installed](https://golang.org/doc/install)
+- [Ritchie installed](https://docs.ritchiecli.io/v/v2.0-pt/getting-started/installation)
+
+## Adding ritchie-formulas to Ritchie CLI
+
+- Run command 
+```bash
+echo '{"provider":"Github", "name":"demo", "version":"2.0.0", "url":"https://github.com/ZupIT/ritchie-formulas", "token": null, "priority":1}' | rit add repo --stdin
+```
+
+- or add via [add repo](https://docs.ritchiecli.io/v/v2.0-pt/tutorials/formulas/como-executar-formulas/formula-hello-world)
+```bash
+rit add repo
+```
+
+## Formula Command
+
+- Prompt
 ```bash
 rit github search handbook
 ```
 
 ## description
 
-This formula search a handhook
+This formula search a handbook on a github repository
+
+## Demo
+
+<img src="demo.gif">
diff --git a/github/search/handbook/demo.gif b/github/search/handbook/demo.gif