Add README

1 files changed, 38 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..c048908
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+## git-merge-pr: apply GitHub pull requests from command-line
+
+## Usage
+
+	git merge-pr [PRNUM][@REMOTE] [GIT-AM FLAGS...]
+
+`git merge-pr` will fetch the patch corresponding to pull request
+number PRNUM of REMOTE repository (defaults to your upstream) and
+applies it on top of the current tree, rewriting the commit message of
+the newest patch to close the pull request upon push (can be disabled
+by setting `merge-pr.autoclose` to false).
+
+Without PRNUM, all open pull requests of REMOTE will be listed.
+This requires `jq` to be available.
+
+Useful `git am` flags:
+
+* `--signoff`
+* `--3way`
+* `--interactive`
+
+## Why rebasing pull requests is preferable to merging them
+
+* Keeps a linear history without merge bubbles.
+* Properly keeps author and committer name as well as author and commit date.
+* Conflicts can easily be dealt with in an ad-hoc fashion.
+* Interactive mode allows for on-the-fly cherry picking.
+
+## Copyright
+
+git-merge-pr is in the public domain.
+
+To the extent possible under law,
+Christian Neukirchen <chneukirchen@gmail.com>
+has waived all copyright and related or
+neighboring rights to this work.
+
+http://creativecommons.org/publicdomain/zero/1.0/