commit 08ca3c539568a65b073345fdb584ceb40920dfa1
from: Omar Polo <op@omarpolo.com>
date: Mon Nov 30 18:33:43 2020 UTC

added readme

commit - 009222a2a8e200f526107d50f54a553aad4e185d
commit + 08ca3c539568a65b073345fdb584ceb40920dfa1
blob - /dev/null
blob + ddf86cccb823b447d69e32315d8eb096fdf146fb (mode 644)
--- /dev/null
+++ 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))
+```