diff options
-rw-r--r-- | README.md | 30 | ||||
-rw-r--r-- | doc/bujo.txt | 17 |
2 files changed, 33 insertions, 14 deletions
@@ -14,14 +14,28 @@ Plug 'jfonseca8/vim-bujo' | |||
14 | ``` | 14 | ``` |
15 | 15 | ||
16 | 16 | ||
17 | ## Use | 17 | |
18 | 18 | ## Use / Mappings | |
19 | * Conveniently open your todo list in vim | 19 | |
20 | - Run :Todo | 20 | * Run: |
21 | * Easily insert a new task | 21 | ``` |
22 | - Press Ctrl-Enter | 22 | :Todo |
23 | * Easily check off a task | 23 | ``` |
24 | - Press Ctrl-Backspace | 24 | * Insert a new task: |
25 | ``` | ||
26 | nmap <C-Enter> <Plug>bujo#AddTodoNormal | ||
27 | imap <C-Enter> <Plug>bujo#AddTodoInsert | ||
28 | ``` | ||
29 | * Check off a task: | ||
30 | ``` | ||
31 | nmap <C-BS> <Plug>bujo#CheckTodoNormal | ||
32 | imap <C-BS> <Plug>bujo#CheckTodoInsert | ||
33 | ``` | ||
34 | * Change cache directory: | ||
35 | ``` | ||
36 | let g:bujo#todo_file_path = $HOME . "/.cache/bujo" | ||
37 | ``` | ||
38 | |||
25 | 39 | ||
26 | 40 | ||
27 | ## Screenshots | 41 | ## Screenshots |
diff --git a/doc/bujo.txt b/doc/bujo.txt index c74d128..74af942 100644 --- a/doc/bujo.txt +++ b/doc/bujo.txt | |||
@@ -34,12 +34,17 @@ very simple and minimialist. | |||
34 | *bujo-features* | 34 | *bujo-features* |
35 | 2. Features~ | 35 | 2. Features~ |
36 | 36 | ||
37 | * Conveniently open your todo list in vim | 37 | * Run: |
38 | - Run :Todo | 38 | :Todo |
39 | * Easily insert a new task | 39 | * Insert a new task: |
40 | - Press <Ctrl-Enter> | 40 | nmap <C-Enter> <Plug>bujo#AddTodoNormal |
41 | * Easily check off a task | 41 | imap <C-Enter> <Plug>bujo#AddTodoInsert |
42 | - Press <Ctrl-Backspace> | 42 | * Check off a task: |
43 | nmap <C-BS> <Plug>bujo#CheckTodoNormal | ||
44 | imap <C-BS> <Plug>bujo#CheckTodoInsert | ||
45 | * Change cache directory: | ||
46 | let g:bujo#todo_file_path = $HOME . "/.cache/bujo" | ||
47 | |||
43 | 48 | ||
44 | ======================================================= | 49 | ======================================================= |
45 | *bujo-notes* | 50 | *bujo-notes* |