Permalink
Browse files

Update readme for beta release (#518)

Updated the readme with more information for the beta release.

I've added a screenshot and added some caveat text explaining some of the flaws we're aware of and stressing the software is still beta and not considered stable.
  • Loading branch information...
lukechilds committed Sep 13, 2018
1 parent 61c8381 commit 63c26a5f819bf082892790747da5cbcc6a552283
Showing with 43 additions and 6 deletions.
  1. +42 −5 README.md
  2. +1 −1 app/package.json
  3. BIN media/screenshots/exchange-view.png
View
@@ -3,7 +3,7 @@
<img src="media/Logo-Black-Text.png" height="260">
<br>
<br>
<p>Desktop App for <a href="https://barterdex.supernet.org">BarterDEX</a></p>
<p>Grandma-Friendly Atomic Swaps</p>
<br>
<a title="Downloads" href="https://github.com/atomiclabs/hyperdex/releases/latest">
<img src="https://img.shields.io/github/downloads/atomiclabs/hyperdex/total.svg">
@@ -14,6 +14,9 @@
<a title="MIT License" href="LICENSE">
<img src="https://img.shields.io/github/license/atomiclabs/hyperdex.svg">
</a>
<a title="Release" href="https://github.com/atomiclabs/hyperdex/releases/latest">
<img src="https://badgen.net/github/release/atomiclabs/hyperdex/">
</a>
<a title="Keybase" target="_blank" href="https://keybase.io/hyperdex">
<img src="https://badgen.net/keybase/pgp/hyperdex">
</a>
@@ -22,14 +25,36 @@
</a>
<br>
<br>
<br>
<img src="media/screenshots/exchange-view.png" width="898">
</div>
**This app is still in private testing phase. The repo has been made public for convenience. Please do not share it.**
## HyperDEX is a truly decentralised cryptocurrency exchange.
## Testing
Built on the Komodo Platform's <a href="https://barterdex.supernet.org">BarterDEX</a> network, HyperDEX is entirely peer-to-peer and all trades are made via on-chain atomic swaps. As a result, you are in full custody of your funds the entire time, your private keys never leave your machine.
Please download the latest [nightly build](https://github.com/atomiclabs/hyperdex-nightlies/releases/latest) and report detailed issues with the "Feedback" button in the app.
## Caveats
### This software is currently in beta
There is a risk of loss of funds. Only trade in real currency if you can take that risk. We recommend trading the test currencies `BEER` and `PIZZA` instead. You can get free `BEER` at the `BEER` [faucet](https://www.atomicexplorer.com/#/faucet).
### All communication is currently unencrypted
Currently HyperDEX is vulnerable to MITM attacks and your actions and addresses are broadcast in plain text. Do not use HyperDEX on a public network other than for testing.
Encrypted communication is planned for our first stable release.
### Most electrum servers are currently ran by community members
This means there is an element of trust involved. It's technically possible for a malicious electrum server operator to double spend and therefore reverse swaps.
We are planning to add an option to connect to your own trusted electrum server.
### We currently only require 1 confirmation for each transaction
For many currencies 1 confirmation is cost effective to 51% attack. This would allow an attacker to double spend and effectively reverse trades.
We are planning to add an option to specify the number of confirmations your are comfortable with per currency.
## Install
@@ -49,6 +74,18 @@ Please download the latest [nightly build](https://github.com/atomiclabs/hyperde
[**Download**](https://github.com/atomiclabs/hyperdex/releases/latest) the `.exe` file.
## Testing
Please download the latest [nightly build](https://github.com/atomiclabs/hyperdex-nightlies/releases/latest) and report detailed issues with the "Feedback" button in the app.
## Donate
HyperDEX is a free and open source project. You can help support its development by donating to the below addresses:
| Symbol | Address |
| ------- | ----------------------------------- |
| **BTC** | `1HyperDEXfMx459ZFh6Ram5uymS8AiRAQf`|
| **KMD** | `RHyper8TJyHK6uZ3AXzUwC2uVRdt7cfxEC`|
## License
View
@@ -3,7 +3,7 @@
"productName": "HyperDEX",
"version": "0.1.0",
"private": true,
"description": "BarterDEX desktop app",
"description": "Grandma-Friendly Atomic Swaps",
"license": "MIT",
"repository": "atomiclabs/hyperdex",
"author": {
View
Binary file not shown.

0 comments on commit 63c26a5

Please sign in to comment.