summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'plugins')
-rw-r--r--plugins/chucknorris/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/chucknorris/README.md b/plugins/chucknorris/README.md
new file mode 100644
index 000000000..be7b97e24
--- /dev/null
+++ b/plugins/chucknorris/README.md
@@ -0,0 +1,20 @@
+# chucknorris
+
+Chuck Norris fortunes plugin for oh-my-zsh
+
+**Maintainers**: [apjanke](https://github.com/apjanke) [maff](https://github.com/maff)
+
+To use it add `chucknorris` to the plugins array in you zshrc file.
+
+```zsh
+plugins=(... chucknorris)
+```
+
+
+Depends on fortune (and cowsay if using chuck_cow) being installed (available via homebrew, apt, ...). Perfectly suitable as MOTD.
+
+
+| Command | Description |
+| ----------- | ------------------------------- |
+| `chuck` | Print random Chuck Norris quote |
+| `chuck_cow` | Print quote in cowthink |