Skip to content

Commit

Permalink
doc: rework installation notes and add mention to license 📖
Browse files Browse the repository at this point in the history
should close #10
  • Loading branch information
AdrieanKhisbe committed Apr 11, 2020
1 parent c256855 commit 32795e0
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,16 @@ Besides *every* `diraction` commands accept a `-h`, `--help` flag that will get
for the specified command.
## Installation
*Installation* is far simple, just get the file and source it.
Other wise with a package manager, (*which I recommend :)*), add the following to your config:
- for [antigen](https://github.com/zsh-users/antigen), just add **diractions** to your bundles as `AdrieanKhisbe/diractions`
`antigen bundle adrieankhisbe/diractions`
- for [zplug](https://github.com/zplug/zplug), add `zplug "adrieankhisbe/diractions"`
If you use package manager, (*which I recommend :)*),
just add the plugin with `adrieankhisbe/diractions` identifier:
- for [antibody](https://github.com/getantibody/antibody), add `antibody bundle "adrieankhisbe/diractions"`
- for [antigen](https://github.com/zsh-users/antigen), add `antigen bundle adrieankhisbe/diractions`
- for [zplug](https://github.com/zplug/zplug), add `zplug "adrieankhisbe/diractions"`
If you want to use the source directly you need to source [`diractions.plugin.zsh`](./diractions.plugin.zsh),
to support completion you need to add the directory to `fpath` so that `__diraction-dispatch` `_diraction` are in it.
## Configuration
Expand Down Expand Up @@ -214,17 +217,19 @@ and is growing ever since with new functionalities. :)
<!-- Maybe list of feature introduced after 1 will go there? -->
<!-- §TODO: contribution note -->
<!-- §TODO contribution note -->
<!-- TODO : licence mention? -->
<!-- Maybe: add version? -->
<!-- §maybe: analytics? -->
<!-- §maybe analytics? -->
### Changelog
Changelog might be consulted in the dedicated [file](CHANGELOG.md)
## License
Licensed under [MIT](./LICENSE).
## Notes
**If you have any remark, refactor suggestion or you are having some unexpected behavior or bug (*soooory*), just post an issue ;)**
Expand Down

0 comments on commit 32795e0

Please sign in to comment.