summaryrefslogtreecommitdiff
path: root/plugins/rand-quote
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2018-06-29 17:55:55 +0200
committerGitHub <noreply@github.com>2018-06-29 17:55:55 +0200
commit1e255a1a8d19f713482c7f2caa639733e8f86b39 (patch)
treec0a409b9054d917db53fd91be71e05db99c1cc2a /plugins/rand-quote
parent787c6899d4db04b3e6cef9a02c6a2ff3d896ece3 (diff)
downloadzsh-1e255a1a8d19f713482c7f2caa639733e8f86b39.tar.gz
zsh-1e255a1a8d19f713482c7f2caa639733e8f86b39.tar.bz2
zsh-1e255a1a8d19f713482c7f2caa639733e8f86b39.zip
rand-quote: add README
Diffstat (limited to 'plugins/rand-quote')
-rw-r--r--plugins/rand-quote/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/rand-quote/README.md b/plugins/rand-quote/README.md
new file mode 100644
index 000000000..c387aaa22
--- /dev/null
+++ b/plugins/rand-quote/README.md
@@ -0,0 +1,15 @@
+# rand-quote plugin
+
+Displays a random quote taken from [quotationspage.com](http://www.quotationspage.com/random.php)
+
+Created by [Eduardo San Martin Morote, aka Posva](https://posva.github.io)
+
+## Usage
+
+Add the plugin to the plugins array in your zshrc file and restart zsh:
+
+```zsh
+plugins=(... rand-quote)
+```
+
+Then, run `quote` to get a new random quote.