From 6b118944809f42d3af2a1b20f71f1aad580dc08d Mon Sep 17 00:00:00 2001 From: Jersey Date: Wed, 24 Jun 2020 15:37:08 -0500 Subject: First release --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 53 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1d95ccd..347100b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,53 @@ -# vim-bullet-journal -I like bullet journals. I like vim. +### vim-bujo + +This plugin allows people to easily access and manage a minimalist todo list from vim. + + +## Installation + +If you use a plugin manager, such as [vim-plug], follow its instructions on how to install plugins from github. + +To install the stable version of the plugin, if using [vim-plug], put this in your `vimrc`/`init.vim`: + +``` +Plug 'jfonseca8/vim-bujo' +``` + + +## Use + +* Conveniently open your todo list in vim + - Run :Todo +* Easily insert a new task + - Press +* Easily check off a task + - Press + + +## Screenshots + +This gif shows how the TODO list opens up in vim. + +We can also see simple controls used to manage the task list itself. + +## Notes + +Feedback and bug reports are welcomed and encouraged. +If you want new features, please do let me know. I +would be honored at the opportunity to make a tool +better for the community. + +I built this because I wanted the ease of vim bindings +with the benefits of keeping a todo list on hand. It is +very simple and minimialist. + +I plan to add diary capabilities, calendar views, history, +and all the fun little quotes and activities that make actual +bullet journaling fun! + +If you would like to work on this project with me, please +reach out to me on [twitter] + + +[twitter]: https://twitter.com/FonsecaJersey +[vim-plug]: https://github.com/junegunn/vim-plug -- cgit v1.2.3