summaryrefslogtreecommitdiff
path: root/plugins/chucknorris
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
committerMarc Cornellà <marc.cornella@live.com>2020-03-11 19:57:46 +0100
commit610b2529d2213a70e3d1153a9baf046c22f298b9 (patch)
tree75278ef17f12844d6810a40250b4f93abd5dd86c /plugins/chucknorris
parentff6d111d793970fc522dd3743367a4c3c46f5fc2 (diff)
downloadzsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.gz
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.tar.bz2
zsh-610b2529d2213a70e3d1153a9baf046c22f298b9.zip
Clean up plugin READMEs and a few plugins
- fasd - history - mercurial - pylint - repo - yii2
Diffstat (limited to 'plugins/chucknorris')
-rw-r--r--plugins/chucknorris/README.md28
1 files changed, 24 insertions, 4 deletions
diff --git a/plugins/chucknorris/README.md b/plugins/chucknorris/README.md
index be7b97e24..35f989180 100644
--- a/plugins/chucknorris/README.md
+++ b/plugins/chucknorris/README.md
@@ -1,6 +1,6 @@
# chucknorris
-Chuck Norris fortunes plugin for oh-my-zsh
+Chuck Norris fortunes plugin for oh-my-zsh. Perfectly suitable as MOTD.
**Maintainers**: [apjanke](https://github.com/apjanke) [maff](https://github.com/maff)
@@ -10,11 +10,31 @@ To use it add `chucknorris` to the plugins array in you zshrc file.
plugins=(... chucknorris)
```
-
-Depends on fortune (and cowsay if using chuck_cow) being installed (available via homebrew, apt, ...). Perfectly suitable as MOTD.
-
+## 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, ...