From 738a4acc4a0601a5fd968cd9183541f96336c894 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Mon, 17 Oct 2016 17:57:16 -0400
Subject: 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.
---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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).
-- 
cgit v1.2.3