diff options
Diffstat (limited to 'plugins/grc/README.md')
| -rw-r--r-- | plugins/grc/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/grc/README.md b/plugins/grc/README.md new file mode 100644 index 000000000..515e87640 --- /dev/null +++ b/plugins/grc/README.md @@ -0,0 +1,15 @@ +# Generic Colouriser plugin + +This plugin adds wrappers for commands supported by [Generic Colouriser](https://github.com/garabik/grc): + +To use it, add `grc` to the plugins array in your zshrc file: + +```zsh +plugins=(... grc) +``` + +## Commands + +The plugin sources the bundled alias generator from the installation, available at `/etc/grc.zsh`. +The complete list of wrapped commands may vary depending on the installed version of `grc`, look +at the file mentioned above (`/etc/grc.zsh`) to see which commands are wrapped. |