diff --git a/README.md b/README.md index 30330fd..b404463 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,26 @@ BitHub is a service that will automatically pay a percentage of Bitcoin funds fo More information can be found in our [announcement blog post](https://whispersystems.org/blog/bithub). +As a user +========= + +Claiming your share of the bitcoin reward when sending code to projects using BitHub is quite simple: if a +[Coinbase](https://coinbase.com) account with the same email address you used to commit your changes exists, it will be credited +the bitcoin amount automatically. If no such account exists, Coinbase will send you an email message with further instructions +on how to retrieve your bounty. + +Technically, the project's BitHub server will query the Coinbase API for a bitcoin address using your commit's email address, and +use that to make a payment on a Coinbase account. + +That's it! + Opting Out ---------- If you'd like to opt out of receiving a payment, simply include the string "FREEBIE" somewhere in your commit message, and you will not receive BTC for that commit. +Using BitHub on your projects +============================= Building ------------- @@ -43,7 +58,7 @@ $ git push heroku master ``` Mailing list ------------- +============ Have a question? Ask on our mailing list!