Skip to content
This repository was archived by the owner on Mar 23, 2021. It is now read-only.

Commit 6c4fe92

Browse files
committed
Add readme for new_project
1 parent 34c0867 commit 6c4fe92

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

new_project/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This project was bootstrapped with [Create Comit App](https://github.com/comit-network/create-comit-app).
2+
3+
## Available Scripts
4+
5+
In the project directory, you can run:
6+
7+
### `yarn create comit-app start-env`
8+
9+
Sets up the development environment, starting blockchain nodes and COMIT nodes.
10+
11+
This command will take hold of your terminal; to run an application using the environment you will have to use a separate terminal.
12+
To clean up the environment, press `CTRL-C`.
13+
14+
### `yarn start`
15+
16+
Displays the environment variables created during environment set-up.
17+
18+
## Example Projects
19+
20+
There are 3 example projects included in the `examples` directory which may guide you when developing your COMIT application:
21+
22+
- [Simple Bitcoin for Ether atomic swap using COMIT](./examples/btc_eth/README.md).
23+
- [Simple ERC20 token for Bitcoin atomic swap using COMIT](./examples/erc20_btc/README.md).
24+
- [Two applications interacting to negotiate and execute an atomic swap](./examples/separate_apps/README.md).

0 commit comments

Comments
 (0)