summaryrefslogtreecommitdiff
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
parente5786259c45ecf02158f13703cf191a429ce8b98 (diff)
Updated README and doc
-rw-r--r--README.md14
-rw-r--r--doc/bujo.txt10
-rw-r--r--plugin/bujo.vim4
3 files changed, 22 insertions, 6 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 ```
diff --git a/doc/bujo.txt b/doc/bujo.txt
index 1bacef0..cea58be 100644
--- a/doc/bujo.txt
+++ b/doc/bujo.txt
@@ -4,7 +4,7 @@
4 4
5Author: Jersey Fonseca <jerseyfonseca@gmail.com> 5Author: Jersey Fonseca <jerseyfonseca@gmail.com>
6 6
7Version: 0.1 7Version: 0.2
8 8
91. Overview 91. Overview
102. Features 102. Features
@@ -15,9 +15,13 @@ Version: 0.1
151. Overview~ 151. Overview~
16 16
17This plugin allows people to easily access and 17This plugin allows people to easily access and
18manage a todo list. 18manage todo lists for their projects.
19 19
20You can stable versions of this plugin at: 20You can access Todo lists of specific projects just
21by being inside of that git repo. In addition, you
22can access a general todo list from any folder.
23
24You can find stable versions of this plugin at:
21 25
22https://github.com/jfonseca8/vim-bujo 26https://github.com/jfonseca8/vim-bujo
23 27
diff --git a/plugin/bujo.vim b/plugin/bujo.vim
index 983c832..e8b7077 100644
--- a/plugin/bujo.vim
+++ b/plugin/bujo.vim
@@ -1,3 +1,7 @@
1" bujo.vim - A minimalist todo list manager
2" Maintainer: Jersey Fonseca <http://www.jerseyfonseca.com/>
3" Version: 0.5
4
1"Make bujo directory if it doesn't exist" 5"Make bujo directory if it doesn't exist"
2let g:bujo#todo_file_path = get(g:, "bujo#todo_file_path", $HOME . "/.cache/bujo") 6let g:bujo#todo_file_path = get(g:, "bujo#todo_file_path", $HOME . "/.cache/bujo")
3if empty(glob(g:bujo#todo_file_path)) 7if empty(glob(g:bujo#todo_file_path))