Merge pull request #68 from matthewkmayer/update-readme

Update readme

README.md

@@ -17,35 +17,26 @@ repos ready for a production release.
     </tr>
 </table>
 
+## Acquiring
 
-## Running
-
-### Compile and run
-
-`RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE"`
-
-### Compile then run
+Prebuilt binaries for Linux and OSX are available on [the releases page](https://github.com/matthewkmayer/release-party-BR/releases).
 
-`cargo build`
-
-`RP_GITHUBTOKEN=your_personal_token_here ./target/debug/release-party-br --org "ORGHERE"`
-
-### Required environment variables
+## Running
 
-`RP_GITHUBTOKEN` - a personal access token to Github
+#### Required information
 
-### Optional: dry-run
+* `RP_GITHUBTOKEN` - environment variable for a personal access token to Github
+* `--org` - GitHub organization name
 
-Say what PRs to create without actually creating them:
+#### Optional behavior
 
-`RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE" --dry-run`
+* `dry-run` - See what PRs would be created: `RP_GITHUBTOKEN=your_personal_token_here cargo run -- --org "ORGHERE" --dry-run`
+* repo ignore list - The `ignoredrepos.toml` file can contain a list of repositories to ignore.  See [ignoredrepos.toml](ignoredrepos.toml) for an example.
 
-### Optional: repo ignore list
+#### Running on OSX
 
-The `ignoredrepos.toml` file can contain a list of repositories to ignore.  See [ignoredrepos.toml](ignoredrepos.toml) 
-for an example.
+`RP_GITHUBTOKEN=your_personal_token_here ./release-party-br-darwin-amd64 --org "ORGHERE"`
 
-### Optional: compile in release mode
+#### Running on Linux
 
-Run `cargo build --release` to create a release binary.  This will run faster than a debug build.  The binary will be created at 
-`./target/release/release-party-br`.
+`RP_GITHUBTOKEN=your_personal_token_here ./release-party-br-linux-amd64 --org "ORGHERE"`