From 987d1d68018ce201d4181c7720e842e5312c8b34 Mon Sep 17 00:00:00 2001
From: Oliver Davies <oliver@oliverdavies.uk>
Date: Wed, 15 Jan 2020 08:14:44 +0000
Subject: [PATCH] Add usage notes for git-publish

---
 bin/git-publish | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/bin/git-publish b/bin/git-publish
index 444a62c..1676739 100755
--- a/bin/git-publish
+++ b/bin/git-publish
@@ -1,6 +1,17 @@
 #!/usr/bin/env php
 <?php
 
+/**
+ * Usage: git publish <remote-branch-name>
+ *
+ * Open the pull request page for <branch>, or the current branch if not
+ * specified. Lands on the new pull request page when no PR exists yet.
+ * The local branch must be tracking the remote branch.
+ *
+ * Use the `BRANCH_PREFIX` environment variable to add a prefix to the
+ * remote branch name.
+ */
+
 $branchesToIgnore = ['develop', 'master', 'staging', 'production'];
 $localBranch = exec('git rev-parse --abbrev-ref HEAD');