Skip to content

Commit 1b70cdf

Browse files
committed
Review comment
1 parent 06c1519 commit 1b70cdf

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,20 @@
22

33
## Welcome to `reactplay.io` ecosystem
44

5-
A package to create the boilerplate files for creating a play withing your local system
5+
A package to generate boilerplate files for creating a play withing your local system. Another idea of this package to create a backbone structure for running all sort of maintenance and house keeping task.
6+
7+
## Command Line Options
8+
Here are few options
9+
- -h/help: Show all available arguments and flags
10+
- -c/create: Creates a play boilerplate within local directory structure
11+
- -u/update: Update an exsiting play
12+
- -p/prepare: Prepre an environment for build/run
613

714
## How it works
15+
16+
### Example: Create a play
817
1. Fork [reactplay](https://github.com/reactplay/react-play)
9-
2. Pull your branch locally
18+
2. Clone your branch
1019
3. Install packages using
1120
```bash
1221
yarn
@@ -23,16 +32,20 @@ A package to create the boilerplate files for creating a play withing your local
2332
6. Provide necessary information
2433
7. Submit your play request
2534
8. It will generate an unique id for you
26-
9. Navigate to root directory of your local reactplay repo and run
35+
9. <b>Navigate to root directory of your local reactplay repo and run
2736
```bash
2837
npx create-react-play -c <the_unique_id>
2938
```
3039
This will create necessary resources and link them together.
40+
</b>
3141
10. Now you will find your play under
3242
```
3343
<reactplay_directory>/plays/<your_play_name>
3444
```
3545
11. Now its all with you, create an awesome play and flaunt it infront of the globe
3646
12. Create a pull request when you are done
3747
38-
48+
### Example: Prepare environemnt
49+
```bash
50+
npx create-react-play -p
51+
```

lib/services/template/play_index.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ const writeFile = (plays, dirs) => {
3030
playPath = pathSegmentation[2];
3131
if (playPath !== play.kebab_name) {
3232
Log.log(
33-
`Play name and path is not matching : ${
34-
play.name
35-
}(${playPath} >> ${JSON.stringify(play)})`
33+
`Play name and path is not matching : ${play.name}(${playPath})`
3634
);
3735
}
3836
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"json-graphql-parser": "^0.0.9",
2626
"prompt": "^1.3.0"
2727
},
28-
"repository": "git://github.com/reactplay/react-play-dev-kit.git",
28+
"repository": "git://github.com/reactplay/create-react-play.git",
2929
"devDependencies": {
3030
"@types/node": "^18.0.0"
3131
}

0 commit comments

Comments
 (0)