Update readme

Author: simoleone

README.md

@@ -1,37 +1,48 @@
 # git-coauthor
-Simple and dependency-free coauthor support porcelain for git.
+Simple multiple author support porcelain for git. Written in pure Bash.
 
 ## Installation
-brew install simoleone/tap/git-coauthor
+`brew install simoleone/tap/git-coauthor`
 
 ## Usage
-Add your friends and colleagues, and probably yourself.
-```bash
-git coauthor add "Cool Person <me@example.com>"
-git coauthor add "Linux Penguin <penguin@example.com>"
-git coauthor add "Jane Smith <jane@example.com>"
 ```
+git coauthor
+    display current coauthors and this usage message
 
-Set up a pair or mob. You can use initials or any matching substring (first match wins).
-```bash
-git coauthor pair cp js
-git coauthor pair cool smith
-```
+git coauthor <initials or name> ...
+    set current co-authors to developers with matching initials or names
 
-Commit as usual. The commit message will be pre-populated with the selected authors. 
-```bash
-git commit
-```
+git coauthor --solo
+    remove current co-authors and go solo
+
+git coauthor --add "Jane Smith <jane@example.com>"
+    add a new author to the database
+
+git coauthor --ls
+    list all authors in the database
 
-Done pairing? Easy.
-```bash
-git coauthor solo
+git coauthor --rm <initials or name>
+    remove author with matching initials or name from the database
 ```
 
 ## Why?
-Github announced support in January 2018. Pairing is a great way to get things done, and
-everyone gets credit in commit graphs as well as in Github's UI.
+Github announced support for `Co-authored-by:` trailers for git commits in January 2018.
+Pairing is a great way to get things done, and everyone gets credit in commit graphs as
+well as in Github's UI by using this method. So basically, this is great.
+
+There are a number of existing solutions to this problem out there, but all of them fall a little
+bit short for one reason or another. The goals of this project are simple:
+
+* No external dependencies (no node, ruby, etc). Should only depend on Bash and Git.
+* Integration with git built-in porcelains. `git commit` should "just work".
+* No munging of author (and do not interfere with gpg commit signing). Use only the Co-authored-by trailer.
+
+## See Also
+* [github help](https://help.github.com/articles/creating-a-commit-with-multiple-authors/) about multiple authors.
+* [github blog](https://blog.github.com/2018-01-29-commit-together-with-co-authors/) announcing support for co-authored-by.
 
-### See Also
-* [github help](https://help.github.com/articles/creating-a-commit-with-multiple-authors/)
-* [github blog](https://blog.github.com/2018-01-29-commit-together-with-co-authors/)
+## Prior Art
+* [chrisk/git-pair](https://github.com/chrisk/git-pair) (depends on ruby, munges author name and email)
+* [findmypast-oss/git-mob#readme](https://github.com/findmypast-oss/git-mob#readme) (depends on node)
+* [pivotal/git_scripts]()https://github.com/pivotal/git_scripts#git-pair) (depends on ruby, munges author name and email)
+* [git-duet/git-duet](https://github.com/git-duet/git-duet) (mungest author name and email, does not integrate git commit)

git_coauthor.sh

@@ -1,4 +1,9 @@
 #!/bin/bash
+#
+# A git porcelain to add co-authored-by trailers to git commits
+# and manage a database of authors.
+#
+# I live at https://github.com/simoleone/git-coauthor
 
 readonly COMMIT_TEMPLATE="${HOME}/.git_coauthor_commit_template"