adding a --fork flag to allow contributors to use their own forks in ponzu-dev workflow & described this in readme

1 files changed, 13 insertions, 3 deletions

diff --git a/README.md b/README.md
index b7401be..8b8dbe1 100644
--- a/README.md
+++ b/README.md
@@ -24,9 +24,8 @@ $ go get github.com/bosssauce/ponzu/...
 
 _A typical contribution workflow might look like:_
 ```bash
-# fork the repository and checkout 
-# ... after forking to your own account
-$ git clone https://github.com/<YOUR_GITHUB>/ponzu 'path/to/local/ponzu'
+# clone the repository and checkout ponzu-dev
+$ git clone https://github.com/bosssauce/ponzu 'path/to/local/ponzu'
 $ git checkout ponzu-dev
 
 # install ponzu with go get or from your own local path
@@ -51,6 +50,17 @@ $ git push origin ponzu-dev
 # ... go to https://github.com/bosssauce/ponzu and create a PR
 ```
 
+**Note:** if you intend to work on your own fork and contribute from it, you will
+need to also pass `--fork=path/to/your/fork` (using OS-standard filepath structure),
+where `path/to/your/fork` _must_ be within `$GOPATH/src`. 
+
+For example: 
+```bash
+# ($GOPATH/src is implied in the fork path, do not add it yourself)
+$ ponzu --dev --fork=github.com/nilslice/ponzu new /path/to/new/project
+```
+
+
 
 ## Credits
 - [golang.org/x/text/transform](https://golang.org/x/text/transform)