From babbe74683c6014b1b73d17586f91be807c65ce0 Mon Sep 17 00:00:00 2001 From: Chris Glass Date: Fri, 28 Feb 2014 15:02:44 +0100 Subject: [PATCH 1/2] Added a small bit about usage for users FREEBIE --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 30330fd..1c6367f 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,24 @@ 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: the only thing you need to do is to create +a [Coinbase](https://coinbase.com) account with the same email address you used to commit your changes. + +The project's BitHub server will then query coinbase for a bitcoin address using your commit's email address, and use that to make a payment on +your 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 +56,7 @@ $ git push heroku master ``` Mailing list ------------- +============ Have a question? Ask on our mailing list! From eafb075eded6d1b9dfe116d9f09084f2692676e3 Mon Sep 17 00:00:00 2001 From: Chris Glass Date: Sun, 2 Mar 2014 10:18:28 +0100 Subject: [PATCH 2/2] Rephrased the Coinbase workflow. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1c6367f..b404463 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,13 @@ More information can be found in our [announcement blog post](https://whispersys As a user ========= -Claiming your share of the bitcoin reward when sending code to projects using BitHub is quite simple: the only thing you need to do is to create -a [Coinbase](https://coinbase.com) account with the same email address you used to commit your changes. +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. -The project's BitHub server will then query coinbase for a bitcoin address using your commit's email address, and use that to make a payment on -your Coinbase account. +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!