summaryrefslogtreecommitdiff
path: root/plugins/hitokoto/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/hitokoto/README.md')
-rw-r--r--plugins/hitokoto/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/hitokoto/README.md b/plugins/hitokoto/README.md
new file mode 100644
index 000000000..3a8758f56
--- /dev/null
+++ b/plugins/hitokoto/README.md
@@ -0,0 +1,15 @@
+# hitokoto plugin
+
+Displays a random quote taken from [hitokoto.cn](https://v1.hitokoto.cn/)
+
+Created by [Sinrimin](https://github.com/sinrimin)
+
+## Usage
+
+Add the plugin to the plugins array in your zshrc file and restart zsh:
+
+```zsh
+plugins=(... hitokoto)
+```
+
+Then, run `hitokoto` to get a new random quote.