aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
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).