From e126e779aefb5e6b1144a9f27d7f373595db2fb4 Mon Sep 17 00:00:00 2001 From: ahmedselim2017 Date: Thu, 25 Jun 2020 02:49:51 +0300 Subject: Added new mappings to readme and doc. --- README.md | 30 ++++++++++++++++++++++-------- doc/bujo.txt | 17 +++++++++++------ 2 files changed, 33 insertions(+), 14 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 bujo#AddTodoNormal + imap bujo#AddTodoInsert + ``` +* Check off a task: + ``` + nmap bujo#CheckTodoNormal + imap 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 - * Easily check off a task - - Press + * Run: + :Todo + * Insert a new task: + nmap bujo#AddTodoNormal + imap bujo#AddTodoInsert + * Check off a task: + nmap bujo#CheckTodoNormal + imap bujo#CheckTodoInsert + * Change cache directory: + let g:bujo#todo_file_path = $HOME . "/.cache/bujo" + ======================================================= *bujo-notes* -- cgit v1.2.3