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

Commit 433f0ad

Browse files
committed
Rewrite READMEs to lead user towards yarn start-env in new_project
1 parent c0cbbbf commit 433f0ad

File tree

5 files changed

+11
-18
lines changed

5 files changed

+11
-18
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ If you have any question please [reach out to the team in our Gitter chat](https
1515
## 2 - Create your first project!
1616

1717
1. `yarn create comit-app <your-app-name>`,
18-
2. `yarn create comit-app start-env` to start blockchain and COMIT nodes,
18+
2. `cd <your-app-name>` and `yarn start-env` to start blockchain and COMIT nodes,
1919
3. Run the [separate-apps](https://github.com/comit-network/create-comit-app/tree/master/new_project/examples/separate_apps) example (in separate terminals for the taker and maker):
20-
1. Navigate to the separate-apps example app directory `cd <path-to-your-app>/examples/separate-apps`,
20+
1. Navigate to the separate-apps example app directory `cd ./examples/separate_apps`,
2121
2. `yarn install` to install dependencies,
22-
3. `yarn run maker` to run the maker app.
23-
4. `yarn run taker` to run the taker app.
22+
3. `yarn run maker` to run the maker app,
23+
4. `yarn run taker` to run the taker app,
2424
5. Follow the steps be hitting `Return` to complete the swap.
2525

2626
You can find additional examples in the [examples](https://github.com/comit-network/create-comit-app/tree/master/new_project/examples) directory that is created as part of step 1.

new_project/examples/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# Example projects for building on top of COMIT
22

3-
This folder contains examples on how to use the `comit-js-sdk` to implement applications on top of COMIT.
3+
This folder contains examples on how to use the `comit-sdk` to implement applications on top of COMIT.
44

55
## Prerequisites
66

77
Make sure that you have Docker installed before proceeding.
88

99
## How to run an example
1010

11-
1. Run `create-comit-app start-env`: This will setup a local environment that can be used across all examples.
12-
2. Checkout the README of the particular example on how to execute it.
11+
Follow the instructions outlined in the README of the particular example.

new_project/examples/btc_eth/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@ An example project that shows how to swap Bitcoin for Ether with COMIT.
44

55
## How to run this example
66

7-
1. Run `yarn start-env` to setup the environment.
7+
Ensure that the environment is up in a separate terminal.
88

9-
In a separate terminal:
10-
11-
1. Run `yarn install` to install the necessary dependencies
12-
2. Run `yarn swap` to start the swap
9+
1. Run `yarn install` to install the necessary dependencies,
10+
2. Run `yarn swap` to start the swap,
1311
3. Hit `CTRL-C` once the swap is done.

new_project/examples/erc20_btc/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ Both maker and taker are processed in the same terminal.
66

77
## How to run this example
88

9-
1. Run `yarn start-env` to setup the environment.
10-
11-
In a separate terminal:
9+
Ensure that the environment is up in a separate terminal.
1210

1311
1. Run `yarn install` to install the necessary dependencies,
1412
2. Run `yarn swap` to start the swap,

new_project/examples/separate_apps/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ It then consists of 5 steps:
1717

1818
## How to run this example
1919

20-
1. Run `yarn start-env` to setup the environment.
21-
22-
In a separate terminal:
20+
Ensure that the environment is up in a separate terminal.
2321

2422
1. Run `yarn install` to install the necessary dependencies,
2523
2. Run `yarn run maker` to start the maker app,

0 commit comments

Comments
 (0)