initial implementation

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a9f881c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Overview
+
+This plugin adds commands which diff the current buffer against the file it
+was loaded from, either the state on disk or the state in version control
+(similar to `vimdiff` except without requiring writing the buffer state to
+disk).
+
+# Commands
+
+## `:DiffAgainstFilesystem`
+
+Opens a diff window which diffs the buffer contents against the contents of
+the file on disk. Use |:DiffStop| to close the diff window.
+
+## `:DiffAgainstVCS`
+
+Opens a diff window which diffs the buffer contents against the contents of
+the file in the most recent commit in version control. Use |:DiffStop| to
+close the diff window. Supports git, svn, darcs, and cvs.
+
+## `:DiffStop`
+
+Closes an active diff window.