github/atomic-swap
1
1
Fork 0
mirror of https://github.com/AthanorLabs/atomic-swap.git synced 2026-01-09 14:18:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

update readme and ui/readme (#259)

Browse Source
This commit is contained in:
noot
2022-12-15 18:39:56 -05:00
committed by GitHub
parent 2dd6e7ceda
commit d955034d63
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -26,10 +26,6 @@ To try the swap on Stagenet/Goerli, follow the instructions [here](./docs/stagen
Please see the [developer docs](docs/developing.md).
### Recovery module
In case the swap process crashes during a swap, you can recover your funds with the recovery module. Please see the instructions [here](./docs/recovery.md).
### RPC API
The swap process comes with a HTTP JSON-RPC API as well as a Websockets API. You can find the documentation [here](./docs/rpc.md).
@@ -40,4 +36,6 @@ If you'd like to contribute, feel free to fork the repo and make a pull request.
## Donations
The work on this project is currently funded via a [Monero CCS Proposal](https://ccs.getmonero.org/proposals/noot-eth-xmr-atomic-swap.html) If you would like help fund this project, feel free to contribute to a follow-up CCS proposal when it's ready for funding. In the meantime, check out other [CCS proposals ready for funding](https://ccs.getmonero.org/funding-required/).
The work on this project has been funded previously by community grants. It is currently not funded; if you'd like to donate, you can do so at the following address:
- XMR `8AYdE4Tzq3rQYh7QNHfHz8HqcgT9kcTcHMcRHL1LhVtqYwah27zwPYGdesBgK5PATvGBAd4BC1t2NfrqKQqDguybQrC1tZb`
- ETH `0x39D3b8cc9D08fD83360dDaCFe054b7D6e7f2cA08`

5
ui/README.md
View File

@@ -16,6 +16,11 @@ yarn install
yarn dev
```
To set the swapd RPC port:
```bash
SWAPD_PORT=5000 yarn dev
```
Navigate to [localhost:8080](http://localhost:8080). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.