Merge pull request #1 from ahmedselim2017/master

Added variables for cache file and mappings

4 files changed, 42 insertions, 22 deletions

diff --git a/README.md b/README.md
index b6b3294..31f21e2 100644
--- a/README.md
+++ b/README.md
@@ -14,14 +14,28 @@ Plug 'jfonseca8/vim-bujo'
 ```
 
 
-## Use
-
-* Conveniently open your todo list in vim
-  - Run :Todo
-* Easily insert a new task
-  - Press Ctrl-Enter
-* Easily check off a task
-  - Press Ctrl-Backspace
+
+## Use / Mappings
+
+* Run:
+  ```
+  :Todo
+  ```
+* Insert a new task:
+  ```
+  nmap <C-Enter> <Plug>bujo#AddTodoNormal
+  imap <C-Enter> <Plug>bujo#AddTodoInsert
+  ```
+* Check off a task:
+  ```
+  nmap <C-BS> <Plug>bujo#CheckTodoNormal
+  imap <C-BS> <Plug>bujo#CheckTodoInsert
+  ```
+* Change cache directory:
+  ```
+  let g:bujo#todo_file_path = $HOME . "/.cache/bujo"
+  ```
+
 
 
 ## 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.
                                         *bujo-features*
 2. Features~
   
-  * Conveniently open your todo list in vim
-    - Run :Todo
-  * Easily insert a new task
-    - Press <Ctrl-Enter>
-  * Easily check off a task
-    - Press <Ctrl-Backspace>
+  * Run:
+    :Todo
+  * Insert a new task:
+    nmap <C-Enter> <Plug>bujo#AddTodoNormal
+    imap <C-Enter> <Plug>bujo#AddTodoInsert
+  * Check off a task:
+    nmap <C-BS> <Plug>bujo#CheckTodoNormal
+    imap <C-BS> <Plug>bujo#CheckTodoInsert
+  * Change cache directory:
+    let g:bujo#todo_file_path = $HOME . "/.cache/bujo"
+
 
 =======================================================
                                            *bujo-notes*
diff --git a/ftplugin/markdown_bujo.vim b/ftplugin/markdown_bujo.vim
index cf79d6f..6838885 100644
--- a/ftplugin/markdown_bujo.vim
+++ b/ftplugin/markdown_bujo.vim
@@ -1,6 +1,6 @@
 " Edit markdown lists
 " Add and remove bullets with ease
-nnoremap <buffer> <C-Enter> i-[] 
-nnoremap <buffer> <C-BS> :.s/\[\]/\[x\]<Enter>
-inoremap <buffer> <C-Enter> -[] 
-inoremap <buffer> <C-BS> <esc>:.s/\[\]/\[x\]<Enter>
+nnoremap <buffer> <Plug>bujo#AddTodoNormal i-[] 
+nnoremap <buffer> <Plug>bujo#CheckTodoNormal :.s/\[\]/\[x\]<Enter>
+inoremap <buffer> <Plug>bujo#AddTodoInsert -[] 
+inoremap <buffer> <Plug>bujo#CheckTodoInsert <esc>:.s/\[\]/\[x\]<Enter>
diff --git a/plugin/bujo.vim b/plugin/bujo.vim
index bc13304..d5203e9 100644
--- a/plugin/bujo.vim
+++ b/plugin/bujo.vim
@@ -1,18 +1,19 @@
 "Make bujo directory if it doesn't exist"
-if empty(glob('~/bujo'))
-  call mkdir($HOME . '/bujo', 'p')
+let g:bujo#todo_file_path = get(g:, "bujo#todo_file_path", $HOME . "/.cache/bujo")
+if empty(glob(g:bujo#todo_file_path))
+  call mkdir(g:bujo#todo_file_path)
 endif
 autocmd bufnewfile todo.md call append(0, '#Todo') 
 autocmd bufnewfile todo.md call append(1, 'Date: ')
 autocmd bufnewfile,bufreadpre todo.md exe "g/Date: */s/Date: /Date: " .strftime("%a %d %b %Y")
-autocmd bufnewfile,Bufwritepre,filewritepre todo.md execute "normal G"
+autocmd bufnewfile,Bufwritepre,filewritepre todo.md execute "normal Go"
 
 
 
 " Open the bujo todo list file
 function s:OpenTodo()
   "30 makes it open at width 30
-  exe ":30vs ~/bujo/todo.md" 
+  exe ":30vs" . g:bujo#todo_file_path . "/todo.md" 
 endfunction
 
 if !exists(":Todo")