summaryrefslogtreecommitdiff
path: root/plugins/geeknote/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/geeknote/README.md')
-rw-r--r--plugins/geeknote/README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/plugins/geeknote/README.md b/plugins/geeknote/README.md
index 3f2353112..99c1fbf5b 100644
--- a/plugins/geeknote/README.md
+++ b/plugins/geeknote/README.md
@@ -1,12 +1,19 @@
-## ZSH-Geeknote
+ZSH-Geeknote
+============
[Geeknote](https://github.com/VitaliyRodnenko/geeknote) plugin for oh-my-zsh.
Plugins provides:
-- auto completion of commands and their options
-- alias `gn`
+* auto completion of commands and their options
+* alias `gn`
-You can find information how to install Geeknote and it's available commands on the [project website](http://www.geeknote.me/).
+## Installation
-Maintainer : Ján Koščo ([@s7anley](https://twitter.com/s7anley))
+### oh-my-zsh
+This plugin is already bundled in oh-my-zsh. To enable just configure plugin definition
+
+ plugins=( ... geeknote ...)
+
+### Antigen
+Use [Antigen's](https://github.com/zsh-users/antigen) bundle command to install by adding `antigen bundle s7anley/zsh-geeknote` to your `.zshrc` along with your other plugins.