summaryrefslogtreecommitdiff
path: root/plugins/octozen
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/octozen')
-rw-r--r--plugins/octozen/README.md12
-rw-r--r--plugins/octozen/octozen.plugin.zsh11
2 files changed, 23 insertions, 0 deletions
diff --git a/plugins/octozen/README.md b/plugins/octozen/README.md
new file mode 100644
index 000000000..2051248ca
--- /dev/null
+++ b/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).
diff --git a/plugins/octozen/octozen.plugin.zsh b/plugins/octozen/octozen.plugin.zsh
new file mode 100644
index 000000000..71ee550a5
--- /dev/null
+++ b/plugins/octozen/octozen.plugin.zsh
@@ -0,0 +1,11 @@
+# octozen plugin
+
+# Displays a zen quote from octocat
+function display_octozen() {
+ curl -m 2 -fsL "https://api.github.com/octocat"
+ add-zsh-hook -d precmd display_octozen
+}
+
+# Display the octocat on the first precmd, after the whole starting process has finished
+autoload -Uz add-zsh-hook
+add-zsh-hook precmd display_octozen