summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/octozen/README.md
diff options
context:
space:
mode:
authornavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
committernavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
commit02f14a9cb152561a5e44062aac79f3b700403b40 (patch)
tree2db8ebda3b7f6f8777783aeb5c60018e6e1359d8 /home/.oh-my-zsh/plugins/octozen/README.md
parentcbbdeb2f6b40a102a829f0c47cff052937231f00 (diff)
omz
Diffstat (limited to 'home/.oh-my-zsh/plugins/octozen/README.md')
-rw-r--r--home/.oh-my-zsh/plugins/octozen/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/octozen/README.md b/home/.oh-my-zsh/plugins/octozen/README.md
new file mode 100644
index 0000000..2051248
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/octozen/README.md
@@ -0,0 +1,12 @@
+# Octozen plugin
+
+Displays a zen quote from GitHub's Octocat on start up.
+
+To use it, add `octozen` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... octozen)
+```
+
+It defines a `display_octozen` function that fetches a GitHub Octocat zen quote.
+NOTE: Internet connection is required (will time out if not fetched in 2 seconds).