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.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/plugins/geeknote/README.md b/plugins/geeknote/README.md
index 3f2353112..95b3aa7dd 100644
--- a/plugins/geeknote/README.md
+++ b/plugins/geeknote/README.md
@@ -1,12 +1,10 @@
-## ZSH-Geeknote
+# Geeknote plugin
-[Geeknote](https://github.com/VitaliyRodnenko/geeknote) plugin for oh-my-zsh.
+This plugin provides autocompletion for [Geeknote](https://github.com/VitaliyRodnenko/geeknote)
+and an alias for `geeknote` called `gn`.
-Plugins provides:
+To use it, add `geeknote` to the plugins array in your zshrc file:
-- 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/).
-
-Maintainer : Ján Koščo ([@s7anley](https://twitter.com/s7anley))
+```zsh
+plugins=( ... geeknote ...)
+```