diff --git a/github/search/handbook/README.md b/github/search/handbook/README.md index e46f9536..7a398d5b 100644 --- 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 + + diff --git a/github/search/handbook/demo.gif b/github/search/handbook/demo.gif new file mode 100644 index 00000000..db81e59f Binary files /dev/null and b/github/search/handbook/demo.gif differ