summaryrefslogtreecommitdiff
path: root/plugins/colored-man-pages
diff options
context:
space:
mode:
authorIulian Onofrei <iulian.onofrei@yahoo.com>2019-08-04 00:33:40 +0300
committerIulian Onofrei <iulian.onofrei@yahoo.com>2019-08-04 00:33:40 +0300
commit26aad59779b2cd7ce313798a4e6b76a29b9f2347 (patch)
treec09eace92498593598090840e3ec18bd0e91ade3 /plugins/colored-man-pages
parent23688fc7ab925111fdb0db07670b6b641e380ec9 (diff)
downloadzsh-26aad59779b2cd7ce313798a4e6b76a29b9f2347.tar.gz
zsh-26aad59779b2cd7ce313798a4e6b76a29b9f2347.tar.bz2
zsh-26aad59779b2cd7ce313798a4e6b76a29b9f2347.zip
Add README file
Diffstat (limited to 'plugins/colored-man-pages')
-rw-r--r--plugins/colored-man-pages/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/colored-man-pages/README.md b/plugins/colored-man-pages/README.md
new file mode 100644
index 000000000..d9f6acb2a
--- /dev/null
+++ b/plugins/colored-man-pages/README.md
@@ -0,0 +1,15 @@
+# Colored man pages plugin
+
+This plugin adds colors to man pages.
+
+To use it, add `colored-man-pages` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... colored-man-pages)
+```
+
+You can also try to color other pages by prefixing the respective command with `colored`:
+
+```zsh
+colored git help clone
+```