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 +++++++++++--- doc/bujo.txt | 10 +++++++--- plugin/bujo.vim | 4 ++++ 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 @@ # 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: ``` 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 @@ Author: Jersey Fonseca -Version: 0.1 +Version: 0.2 1. Overview 2. Features @@ -15,9 +15,13 @@ Version: 0.1 1. Overview~ This plugin allows people to easily access and -manage a todo list. +manage todo lists for their projects. -You can stable versions of this plugin at: +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 find stable versions of this plugin at: https://github.com/jfonseca8/vim-bujo 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 @@ +" bujo.vim - A minimalist todo list manager +" Maintainer: Jersey Fonseca +" Version: 0.5 + "Make bujo directory if it doesn't exist" let g:bujo#todo_file_path = get(g:, "bujo#todo_file_path", $HOME . "/.cache/bujo") if empty(glob(g:bujo#todo_file_path)) -- cgit v1.2.3