diff --git a/packages/chess-app/README.md b/packages/chess-app/README.md index 38ebf9fa8..d0b0dd87f 100644 --- a/packages/chess-app/README.md +++ b/packages/chess-app/README.md @@ -1,4 +1,18 @@ -# Bitcoin Computer Chess App +
+ +This app allows two users to wager on a game of chess. There are no middlemen, the wagers are held in a 2-of-2 multisig address between the players. **The current version requires that the winner trusts that the looser will help to retrieve the winnings, otherwise the wagers remain locked.** + +A future version will be completely trustless, governed by a smart contract. + +**This is a work in progress and not recommended for production use.** ## Usage diff --git a/packages/chess-app/imgs/chess.png b/packages/chess-app/imgs/chess.png new file mode 100644 index 000000000..66073e1bb Binary files /dev/null and b/packages/chess-app/imgs/chess.png differ diff --git a/packages/chess-contracts/README.md b/packages/chess-contracts/README.md index a0aa2b5b9..24ffb3b4e 100644 --- a/packages/chess-contracts/README.md +++ b/packages/chess-contracts/README.md @@ -8,6 +8,14 @@ Start a Bitcoin Computer Node in the package `node`. Copy the `.env.example` fil cp .env.example .env ``` +### Deploy + +Before you can start the chess-app, you need to deploy the chess contract. + +``` +npm run deploy +``` + ### Test ```