Skip to content
This repository has been archived by the owner on Feb 3, 2022. It is now read-only.

Added a small bit about usage for users #35

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down Expand Up @@ -43,7 +58,7 @@ $ git push heroku master
```

Mailing list
------------
============

Have a question? Ask on our mailing list!

Expand Down