branch: externals/vc-got
commit 08ca3c539568a65b073345fdb584ceb40920dfa1
Author: Omar Polo <o...@omarpolo.com>
Commit: Omar Polo <o...@omarpolo.com>
added readme
---
README.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ddf86cc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# vc-got
+
+This is an **experimental** Emacs VC back-end for the [Game of
+Tree](http://gameoftrees.org/) version control system.
+
+Use it at your own risk.
+
+------
+
+To start using it, you need to add `Got` to `vc-handled-backends` and
+make sure that `vc-got` is within your `load-path`. You shouldn't
+require the library.
+
+```emacs-lisp
+(push 'Got vc-handled-backends)
+```
+
+With `use-package` something like this should be enough:
+
+```emacs-lisp
+(use-package vc-got
+ :load-path "/path/to/vc-got/"
+ :init (push 'Got vc-handled-backends))
+```
