diff options
| author | Gregor Trefs <Gregor.Trefs@gmail.com> | 2021-08-10 21:02:06 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-10 21:02:06 +0200 |
| commit | b79fba7b0d38aa61afaeeaaa7fab6992dbfb6db3 (patch) | |
| tree | b4f0a6e1e254f32308d52f2f33132ce5e8ab0b51 /plugins/octozen/README.md | |
| parent | bca73e18584771fd6db770055dac25b5728764c3 (diff) | |
| download | zsh-b79fba7b0d38aa61afaeeaaa7fab6992dbfb6db3.tar.gz zsh-b79fba7b0d38aa61afaeeaaa7fab6992dbfb6db3.tar.bz2 zsh-b79fba7b0d38aa61afaeeaaa7fab6992dbfb6db3.zip | |
feat(plugins): `octozen` shows an Octocat zen quote on startup (#5959)
Co-authored-by: Marc Cornellà <hello@mcornella.com>
Diffstat (limited to 'plugins/octozen/README.md')
| -rw-r--r-- | plugins/octozen/README.md | 12 |
1 files changed, 12 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). |