From b79fba7b0d38aa61afaeeaaa7fab6992dbfb6db3 Mon Sep 17 00:00:00 2001
From: Gregor Trefs <Gregor.Trefs@gmail.com>
Date: Tue, 10 Aug 2021 21:02:06 +0200
Subject: feat(plugins): `octozen` shows an Octocat zen quote on startup
 (#5959)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Marc Cornellà <hello@mcornella.com>
---
 plugins/octozen/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 plugins/octozen/README.md

(limited to 'plugins/octozen/README.md')

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).
-- 
cgit v1.2.3-70-g09d2