summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/chucknorris/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/chucknorris/README.md')
-rw-r--r--oh-my-zsh/plugins/chucknorris/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/chucknorris/README.md b/oh-my-zsh/plugins/chucknorris/README.md
new file mode 100644
index 0000000..b51875d
--- /dev/null
+++ b/oh-my-zsh/plugins/chucknorris/README.md
@@ -0,0 +1,38 @@
+# chucknorris
+
+Chuck Norris fortunes plugin for Oh My Zsh. Perfectly suitable as MOTD.
+
+To use it add `chucknorris` to the plugins array in you zshrc file.
+
+```zsh
+plugins=(... chucknorris)
+```
+
+## Usage
+
+| Command | Description |
+| ----------- | ------------------------------- |
+| `chuck` | Print random Chuck Norris quote |
+| `chuck_cow` | Print quote in cowthink |
+
+Example: output of `chuck_cow`:
+
+```
+Last login: Fri Jan 30 23:12:26 on ttys001
+ ______________________________________
+( When Chuck Norris plays Monopoly, it )
+( affects the actual world economy. )
+ --------------------------------------
+ o ^__^
+ o (oo)\_______
+ (__)\ )\/\
+ ||----w |
+ || ||
+```
+
+## Requirements
+
+- `fortune`
+- `cowsay` if using `chuck_cow`
+
+Available via homebrew, apt, ...