docs: readme
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

This commit is contained in:
abs3nt 2023-03-05 23:52:48 -08:00
parent 0279e65cee
commit f0c93b4fde

View File

@ -1,4 +1,5 @@
## Quickstart
### Install
```
go install github.com/abs3ntdev/haunt@latest
```
@ -11,6 +12,14 @@ cd haunt
make build && sudo make install
```
### Completions
completions will be automatically installed if you used the Makefile, if you did not you can generate completions with `haunt completion [bash/fish/powershell/zsh]`
for example: `haunt completion zsh > _haunt`
you can also source the output of the completion command directly in your .zshrc with:\
`source <(haunt completion zsh) && compdef _haunt haunt`
## Commands List
### Init Command