From 5f18dbf895675ff22dcbe2afa78b72b74350ea58 Mon Sep 17 00:00:00 2001
From: Sung Won Cho <hello@sung.io>
Date: Sun, 16 Jun 2019 03:52:22 +1000
Subject: Add a completion plugin for dnote (#7885)

---
 plugins/dnote/README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 plugins/dnote/README.md

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

diff --git a/plugins/dnote/README.md b/plugins/dnote/README.md
new file mode 100644
index 000000000..e1b9b7044
--- /dev/null
+++ b/plugins/dnote/README.md
@@ -0,0 +1,51 @@
+# Dnote Plugin
+
+This plugin adds auto-completion for [Dnote](https://dnote.io) project.
+
+To use it, add `dnote` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(dnote)
+```
+
+## Usage
+
+At the basic level, this plugin completes all Dnote commands.
+
+```zsh
+$ dnote a(press <TAB> here)
+```
+
+would result in:
+
+```zsh
+$ dnote add
+```
+
+For some commands, this plugin dynamically suggests matching book names.
+
+For instance, if you have three books that begin with 'j': 'javascript', 'job', 'js',
+
+```zsh
+$ dnote view j(press <TAB> here)
+```
+
+would result in:
+
+```zsh
+$ dnote v j
+javascript  job         js
+```
+
+As another example,
+
+```zsh
+$ dnote edit ja(press <TAB> here)
+```
+
+would result in:
+
+
+```zsh
+$ dnote v javascript
+``````
-- 
cgit v1.2.3-70-g09d2