diff options
author | Jersey <fonseca@uchicago.edu> | 2020-06-24 20:37:08 +0000 |
---|---|---|
committer | Jersey <fonseca@uchicago.edu> | 2020-06-24 20:37:08 +0000 |
commit | 6b118944809f42d3af2a1b20f71f1aad580dc08d (patch) | |
tree | f653b37999204ae5a3ce813d674c1f71f35f6efe /README.md | |
parent | 90e5518188c66bbdb40398a7f0c88ca1f1115958 (diff) |
First release
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 55 |
1 files changed, 53 insertions, 2 deletions
@@ -1,2 +1,53 @@ | |||
1 | # vim-bullet-journal | 1 | ### vim-bujo |
2 | I like bullet journals. I like vim. | 2 | |
3 | This plugin allows people to easily access and manage a minimalist todo list from vim. | ||
4 | |||
5 | |||
6 | ## Installation | ||
7 | |||
8 | If you use a plugin manager, such as [vim-plug], follow its instructions on how to install plugins from github. | ||
9 | |||
10 | To install the stable version of the plugin, if using [vim-plug], put this in your `vimrc`/`init.vim`: | ||
11 | |||
12 | ``` | ||
13 | Plug '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 | |||
29 | This gif shows how the TODO list opens up in vim. | ||
30 | |||
31 | We can also see simple controls used to manage the task list itself. | ||
32 | |||
33 | ## Notes | ||
34 | |||
35 | Feedback and bug reports are welcomed and encouraged. | ||
36 | If you want new features, please do let me know. I | ||
37 | would be honored at the opportunity to make a tool | ||
38 | better for the community. | ||
39 | |||
40 | I built this because I wanted the ease of vim bindings | ||
41 | with the benefits of keeping a todo list on hand. It is | ||
42 | very simple and minimialist. | ||
43 | |||
44 | I plan to add diary capabilities, calendar views, history, | ||
45 | and all the fun little quotes and activities that make actual | ||
46 | bullet journaling fun! | ||
47 | |||
48 | If you would like to work on this project with me, please | ||
49 | reach out to me on [twitter] | ||
50 | |||
51 | |||
52 | [twitter]: https://twitter.com/FonsecaJersey | ||
53 | [vim-plug]: https://github.com/junegunn/vim-plug | ||