aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2016-10-17 17:57:16 -0400
committerTeddy Wing2016-10-17 17:57:16 -0400
commit738a4acc4a0601a5fd968cd9183541f96336c894 (patch)
treef841b07716f3d998852cd6e1e43e3e765101f716 /README.md
parent632ca4e11f40d72fafdb1fd2534fd03422164d17 (diff)
downloadvim-twodo-738a4acc4a0601a5fd968cd9183541f96336c894.tar.bz2
Add README and license
Include a description and screenshot as part of the README. The `example.todo` file was used as a base for the screenshot. Add a license file for the GNU GPLv3.
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5c79d6e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+vim-twodo
+=========
+
+To-do list plugin for Vim. Provides syntax highlighting and mappings to help
+manage my personal to-do lists. To-do files use a `.todo` extension.
+
+
+## Screenshot
+![screenshot](./screenshot.png)
+
+
+## Syntax
+Certain line prefixes define different to-do types. These types will be coloured
+differently by the plugin's syntax highlighter.
+
+ - Regular priority to-dos are prefixed with a `- `
+ _ A low priority to-do
+ ! A high priority to-do
+ x A deleted to-do
+ S A partially completed to-do
+ v A completed to-do
+
+
+## License
+Copyright © 2016 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).