summaryrefslogtreecommitdiff
path: root/.config/zsh/oh-my-zsh/plugins/grc/README.md
diff options
context:
space:
mode:
authorPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
committerPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
commit1eb69e9a795cc19450178c07d8d382622bc7ad70 (patch)
treeb6bc60605044fe929986f31b3b6bf4fee9b56e14 /.config/zsh/oh-my-zsh/plugins/grc/README.md
first commit
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/grc/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/grc/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/grc/README.md b/.config/zsh/oh-my-zsh/plugins/grc/README.md
new file mode 100644
index 0000000..515e876
--- /dev/null
+++ b/.config/zsh/oh-my-zsh/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.