diff options
| author | Tuowen Zhao <ztuowen@gmail.com> | 2021-08-16 19:36:49 -0600 |
|---|---|---|
| committer | Tuowen Zhao <ztuowen@gmail.com> | 2021-08-16 19:36:49 -0600 |
| commit | f8b7b6584bf1ca7e836ba9cc13fcce573047fb07 (patch) | |
| tree | 3a49f51b1c5632a7d89bdea855ce873ff7b1060b /plugins/octozen/README.md | |
| parent | 617ed3bd9f3d9519fe2354941f3dbf15b0c712ee (diff) | |
| parent | 11e22ed0b5c1aebd6e990ea7a885bdf03ab6555a (diff) | |
| download | zsh-f8b7b6584bf1ca7e836ba9cc13fcce573047fb07.tar.gz zsh-f8b7b6584bf1ca7e836ba9cc13fcce573047fb07.tar.bz2 zsh-f8b7b6584bf1ca7e836ba9cc13fcce573047fb07.zip | |
Merge remote-tracking branch 'origin/master'
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). |