summarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorAvahe Kellenberger2019-04-12 11:30:47 -0400
committerAvahe Kellenberger2019-04-13 01:57:13 -0400
commit99166a650c5a6f912e0cb263f85aa3f6853c0dcb (patch)
treef6e6d6f063523748cd349ce6d7a667402d574874
parent256711d7f20059ac14991bbd3418d5af129486b4 (diff)
downloadaur-99166a650c5a6f912e0cb263f85aa3f6853c0dcb.tar.gz
Create README.md
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..1fe9c226da66
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# git-pair
+Pair Programming git Management Tool
+
+## Build Instructions
+
+```sh
+$ gcc pair.c -o pair
+```
+
+## Usage
+
+Run `./pair help` to see available commands.
+
+<hr>
+
+Initialize your workspace by adding and selecting git authors:
+```sh
+$ ./pair init
+```
+
+To select or change the current author/co-author, execute without parameters:
+
+```sh
+$ ./pair
+```
+
+Add new authors:
+
+```sh
+$ ./pair add
+```
+