bisq/README.md
Chris Beams 43cf337fe4
Support code coverage using JaCoCo and Coveralls
The Gradle build now supports generating code coverage reports using
JaCoCo. The reports can be run with:

    ./gradle jacocoTestReport

and then view the HTML output at:

    build/reports/jacoco/test/html/index.html

The bitsquare repository has now also been registered with a (free)
account at http://coveralls.io. Our Travis CI configuration has been
updated to publish JaCoCo XML test report data to coveralls.io, which
results in the reports found at:

 - https://coveralls.io/r/bitsquare/bitsquare

For more information on the JaCoCo and Coveralls Gradle plugins, see:

 - http://www.gradle.org/docs/current/userguide/jacoco_plugin.html
 - https://github.com/kt3k/coveralls-gradle-plugin
2014-11-03 13:56:14 +01:00

54 lines
3.4 KiB
Markdown

<img src="https://bitsquare.io/images/logo.png" width="240"/>
[![Build Status](https://travis-ci.org/bitsquare/bitsquare.svg?branch=master)](https://travis-ci.org/bitsquare/bitsquare)
[![Coverage Status](https://img.shields.io/coveralls/bitsquare/bitsquare.svg)](https://coveralls.io/r/bitsquare/bitsquare)
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 machines, 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 via the Bitsquare UI, 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 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](https://bitsquare.io/overview.png),
[whitepaper](https://bitsquare.io/whitepaper.pdf), [arbitration](https://bitsquare.io/arbitration_system.pdf) and [risk analysis](https://bitsquare.io/risk_analysis.pdf) documents. Several [screencasts](https://www.youtube.com/playlist?list=PLXvC3iNe_di9bL1A5xyAKI2PzNg8jU092) 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:
- The [Bitsquare Website](https://bitsquare.io)
- 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
- Get in [contact](https://bitsquare.io/contact/) with us
- GitHub [Issues](https://github.com/bitsquare/bitsquare/issues)
License
-------
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).
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:
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.
See [LICENSE](LICENSE) for complete details.