From bdcfabff28b394d32b5bce4ac87170f751d9437f Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Fri, 3 Oct 2014 11:25:56 +0200 Subject: [PATCH] Refine README See #95 --- README.md | 51 ++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 38 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 419987efa45..b9094fdc430 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,51 @@ -![](http://bitsquare.io/images/logo_240.png) + [![Build Status](https://travis-ci.org/bitsquare/bitsquare.svg?branch=master)](https://travis-ci.org/bitsquare/bitsquare) -Bitsquare is a cross-platform application that allows users to trade fiat money (dollars, euros, etc) for bitcoin without relying on centralized exchanges such as Coinbase, Bitstamp or (the former) Mt. Gox. + +What is Bitsquare? +------------------ + +Bitsquare is a cross-platform desktop application that allows users to trade fiat money (dollars, euros, etc) for bitcoin without relying on centralized exchanges such as Coinbase, Bitstamp or (the former) Mt. Gox. By running Bitsquare on their local machine, users form a peer-to-peer network. Offers to buy and sell bitcoin are broadcast to that network, and through the process of offering and accepting these trades, a market is established. -There are no central points of control or failure in the Bitsquare network. There are no trusted third parties. When two parties agree to trade fiat money for bitcoin, the bitcoin to be bought or sold is held in escrow using the multisignature transaction capabilities built in to the bitcoin protocol. +There are no central points of control or failure in the Bitsquare network. There are no trusted third parties. When two parties agree to trade fiat money for bitcoin, the bitcoin to be bought or sold is held in escrow using multisignature transaction capabilities native to the bitcoin protocol. + +Because the fiat money portion of any trade must be transferred via traditional means such as a wire transfer, Bitsquare incorporates first-class support for human arbitration to resolve any errors or disputes. + +You can read about all of this and more in the [overview](http://bitsquare.io/images/overview.png), [whitepaper](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#), [arbitration](https://docs.google.com/document/d/1LJCRFdtM2Jn2Oiv49qRXwBDG8HZD0Hiedy8tNjErHps/edit) and [risk analysis](https://docs.google.com/document/d/1sHwU7K7C8Nl-fS4Z6X88L-NVJ_WBiKnsSpYpYfyqUXA/edit) documents. Several [screencasts](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#) are available as well. + + +Status +------ + +The [team](https://github.com/orgs/bitsquare/people) is currently working on a series of pre-releases on the way to version 1.0. See the [roadmap](https://github.com/bitsquare/bitsquare/wiki/Roadmap) for details. + +**Alpha testers welcome!** Please see the [instructions for alpha testing](https://github.com/bitsquare/bitsquare/wiki/Alpha-Testing), where you'll find detailed information about downloading and using our native installers, [building from source](doc/build.md) and more. + + +Staying in Touch +---------------- + +Contact the team and keep up to date using any of the following: -Because the fiat money portion of any trade must be transferred via traditional means such as wire transfers, Bitsquare includes first-class support for human arbitration to handle any errors or disputes. + - The [#bitsquare](https://webchat.freenode.net/?channels=bitsquare) IRC channel on Freenode ([logs](https://botbot.me/freenode/bitsquare)) + - Our [mailing list](https://groups.google.com/forum/#!forum/bitsquare) + - [@bitsquare_](https://twitter.com/bitsquare_) on Twitter + - [team@bitsquare.io](mailto:team@bitsquare.io) + - The [Bitsquare thread](https://bitcointalk.org/index.php?topic=647457) on the Bitcointalk forum + - GitHub [Issues](https://github.com/bitsquare/bitsquare/issues) -You can read about all of this and more in the [overview](), [whitepaper](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#), [arbitration](https://docs.google.com/document/d/1LJCRFdtM2Jn2Oiv49qRXwBDG8HZD0Hiedy8tNjErHps/edit) and [risk analysis](https://docs.google.com/document/d/1sHwU7K7C8Nl-fS4Z6X88L-NVJ_WBiKnsSpYpYfyqUXA/edit) documents. Several [screencasts](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#) are available as well. +License +------- -## Status +Bitsquare is [free software](https://www.gnu.org/philosophy/free-sw.html), licensed under version 3 of the [GNU Affero General Public License](https://gnu.org/licenses/agpl.html). -The team is currently working toward an initial [v0.1.0](https://github.com/bitsquare/bitsquare/milestones/v0.1.0) release. +In short, this means you are free to fork this repository and do anything with it that you please. However, if you _distribute_ your changes, i.e. create your own build of the software and make it available for others to use, you must: -## Staying in touch + 1. Publish your changes under the same license, so as to ensure the software remains free. + 2. Use a name and logo substantially different than "Bitsquare" and the Bitsquare logo seen here. This allows for competition without confusion. -* [Mailing list](https://groups.google.com/forum/#!forum/bitsquare) -* [IRC](https://webchat.freenode.net/?channels=bitsquare) -* [Twitter](https://twitter.com/bitsquare_) -* [Email](mailto:team@bitsquare.io) -* [Bitcointalk](https://bitcointalk.org/index.php?topic=647457) +See [LICENSE](LICENSE) for complete details.