summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md55
1 files changed, 53 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1d95ccd..347100b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
1# vim-bullet-journal 1### vim-bujo
2I like bullet journals. I like vim. 2
3This plugin allows people to easily access and manage a minimalist todo list from vim.
4
5
6## Installation
7
8If you use a plugin manager, such as [vim-plug], follow its instructions on how to install plugins from github.
9
10To install the stable version of the plugin, if using [vim-plug], put this in your `vimrc`/`init.vim`:
11
12```
13Plug 'jfonseca8/vim-bujo'
14```
15
16
17## Use
18
19* Conveniently open your todo list in vim
20 - Run :Todo
21* Easily insert a new task
22 - Press <Ctrl-Enter>
23* Easily check off a task
24 - Press <Ctrl-Backspace>
25
26
27## Screenshots
28
29This gif shows how the TODO list opens up in vim.
30
31We can also see simple controls used to manage the task list itself.
32
33## Notes
34
35Feedback and bug reports are welcomed and encouraged.
36If you want new features, please do let me know. I
37would be honored at the opportunity to make a tool
38better for the community.
39
40I built this because I wanted the ease of vim bindings
41with the benefits of keeping a todo list on hand. It is
42very simple and minimialist.
43
44I plan to add diary capabilities, calendar views, history,
45and all the fun little quotes and activities that make actual
46bullet journaling fun!
47
48If you would like to work on this project with me, please
49reach out to me on [twitter]
50
51
52[twitter]: https://twitter.com/FonsecaJersey
53[vim-plug]: https://github.com/junegunn/vim-plug