Create README.md

anorth · Apr 15, 2019 · 1d323e4 · 1d323e4
1 parent 78887ac
commit 1d323e4
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# gflows
+Git/GitHub workflow scripts for rapid and parallel team development
+
+### Installation
+Symlink `gflow.py` into `~/bin/gflow`, or somewhere else in your `$PATH`.
+Invoke as `gflow up`, etc.
+
+Optionally, you can symlink it multiple times with different names, 
+those names corresponding to the names of commands: `up`, `land` etc.
+Then you can invoke the command directly as `up` or `land` without the preceding `gflow`.