summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJersey <fonseca@uchicago.edu>2020-06-26 19:20:02 +0000
committerJersey <fonseca@uchicago.edu>2020-06-26 19:20:02 +0000
commit0807b7aed40a1c9758f6944e0ee8c8f448ff6c58 (patch)
tree49bfc3ee0ca26e7bb7f864302afff347a1ef44eb /README.md
parente5786259c45ecf02158f13703cf191a429ce8b98 (diff)
Updated README and doc
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7dd5a31..b76f3b9 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
1# vim-bujo 1# vim-bujo
2 2
3This plugin allows people to easily access and manage a minimalist todo list from vim. 3This plugin allows people to easily access and manage todo lists for their projects from vim.
4 4
5 5
6This plugin allows people to easily access and manage todo lists for their projects.
7
8You can access Todo lists of specific projects just by being inside of that git repo. In addition, you can access a general todo list from any folder.
9
6## Installation 10## Installation
7 11
8If you use a plugin manager, such as [vim-plug], follow its instructions on how to install plugins from github. 12If you use a plugin manager, such as [vim-plug], follow its instructions on how to install plugins from github.
@@ -17,9 +21,13 @@ Plug 'vuciv/vim-bujo'
17 21
18## Use / Mappings 22## Use / Mappings
19 23
20* Run: 24* Open general Todo:
25 ```
26 :Todo g
27 ```
28* Open Todo of git repo:
21 ``` 29 ```
22 :Todo 30 :Todo // from git repo
23 ``` 31 ```
24* Insert a new task: 32* Insert a new task:
25 ``` 33 ```