From 6b118944809f42d3af2a1b20f71f1aad580dc08d Mon Sep 17 00:00:00 2001
From: Jersey <fonseca@uchicago.edu>
Date: Wed, 24 Jun 2020 15:37:08 -0500
Subject: First release

---
 README.md       | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 doc/bujo.txt    | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 plugin/bujo.vim | 12 +-----------
 3 files changed, 109 insertions(+), 13 deletions(-)
 create mode 100644 doc/bujo.txt

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 <Ctrl-Enter>
+* Easily check off a task
+  - Press <Ctrl-Backspace>
+
+
+## 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
diff --git a/doc/bujo.txt b/doc/bujo.txt
new file mode 100644
index 0000000..c74d128
--- /dev/null
+++ b/doc/bujo.txt
@@ -0,0 +1,55 @@
+*bujo.txt*                                *bujo.txt*
+                        Bujo~
+             Bullet Journal Vim Plugin~
+
+Author: Jersey Fonseca <jerseyfonseca@gmail.com>
+
+Version: 0.1
+
+1. Overview
+2. Features
+3. FAQ
+
+=======================================================
+                                        *bujo-overview*
+1. Overview~
+
+This plugin allows people to easily access and
+manage a todo list.
+
+You can stable versions of this plugin at: 
+
+https://github.com/jfonseca8/vim-bujo
+
+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.
+
+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.
+
+=======================================================
+                                        *bujo-features*
+2. Features~
+  
+  * Conveniently open your todo list in vim
+    - Run :Todo
+  * Easily insert a new task
+    - Press <Ctrl-Enter>
+  * Easily check off a task
+    - Press <Ctrl-Backspace>
+
+=======================================================
+                                           *bujo-notes*
+3. Notes
+
+I am not sure that writing this todo file into the root
+directory is the best way to go about it. I have never
+made anything like this, and couldn't find resources
+that were helpful with how to handle such situations.
+
+If this annoys anyone, please do let me know. I am
+happy to change it, and happy to know if there are
+better standardized ways to go about this
diff --git a/plugin/bujo.vim b/plugin/bujo.vim
index cc8a84e..9531421 100644
--- a/plugin/bujo.vim
+++ b/plugin/bujo.vim
@@ -1,17 +1,7 @@
-autocmd BufWritePre,FileWritePre todo.md   ks|call LastMod()|'s
-fun LastMod()
-  if line("$") > 20
-    let l = 20
-  else
-    let l = line("$")
-  endif
-  exe "1," . l . "g/Date: /s/Date: .*/Date: " .
-  \ strftime("%Y %b %d")
-endfun
-
 "Make bujo directory if it doesn't exist"
 if empty(glob('~/bujo'))
   call mkdir($HOME . '/bujo', 'p')
+
 endif
 
 " Open the bujo todo list file
-- 
cgit v1.2.3