From 0807b7aed40a1c9758f6944e0ee8c8f448ff6c58 Mon Sep 17 00:00:00 2001 From: Jersey Date: Fri, 26 Jun 2020 14:20:02 -0500 Subject: Updated README and doc --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7dd5a31..b76f3b9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # vim-bujo -This plugin allows people to easily access and manage a minimalist todo list from vim. +This plugin allows people to easily access and manage todo lists for their projects from vim. +This plugin allows people to easily access and manage todo lists for their projects. + +You 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. + ## Installation If 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' ## Use / Mappings -* Run: +* Open general Todo: + ``` + :Todo g + ``` +* Open Todo of git repo: ``` - :Todo + :Todo // from git repo ``` * Insert a new task: ``` -- cgit v1.2.3 From 8249dbf99f739360defdabc8da964ce9268781f3 Mon Sep 17 00:00:00 2001 From: Jersey Fonseca Date: Fri, 26 Jun 2020 14:21:40 -0500 Subject: Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b76f3b9..9241978 100644 --- a/README.md +++ b/README.md @@ -21,13 +21,13 @@ Plug 'vuciv/vim-bujo' ## Use / Mappings -* Open general Todo: +* Open Todo of current git repo: ``` - :Todo g + :Todo // from git repo ``` -* Open Todo of git repo: +* Open general Todo: ``` - :Todo // from git repo + :Todo g ``` * Insert a new task: ``` @@ -50,7 +50,7 @@ Plug 'vuciv/vim-bujo' ## Screenshots -This gif shows how the TODO list opens up in vim. +This gif shows how the Todo list opens up in vim. ![Gif of Bujo use](https://raw.githubusercontent.com/jfonseca8/vim-bujo/master/screenshots/bujo.gif) -- cgit v1.2.3 From 7573cf6459273425d10a5972a76f1a2a7b376063 Mon Sep 17 00:00:00 2001 From: Jersey Fonseca Date: Fri, 26 Jun 2020 14:22:32 -0500 Subject: Update README.md --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9241978..468887b 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,7 @@ This plugin allows people to easily access and manage todo lists for their projects from vim. - -This plugin allows people to easily access and manage todo lists for their projects. - -You 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. +You can easily access and manage Todo lists of specific projects or a general Todo list. ## Installation -- cgit v1.2.3