Skip to content

Commit 1e2b299

Browse files
committed
Docs: update README.md
1 parent 3d71d92 commit 1e2b299

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

README.md

+34-4
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@
1313
A CLI tool to run multiple npm-scripts in parallel or sequential.
1414

1515
```
16-
> npm-run-all clean lint build:*
16+
$ npm-run-all clean lint build:*
1717
```
1818

1919
```
20-
> npm-run-all clean --parallel "build:* -- --watch"
20+
$ npm-run-all --parallel watch:*
2121
```
2222

2323
## Installation
@@ -31,7 +31,7 @@ npm install npm-run-all
3131

3232
## CLI Commands
3333

34-
This `npm-run-all` package introduces 3 CLI commands.
34+
This `npm-run-all` package provides 3 CLI commands.
3535

3636
- [npm-run-all]
3737
- [run-s]
@@ -40,7 +40,7 @@ This `npm-run-all` package introduces 3 CLI commands.
4040
The main command is [npm-run-all].
4141
We can make complex plans with [npm-run-all] command.
4242

43-
Both [run-s] and [run-p] are the shorthand commands.
43+
Both [run-s] and [run-p] are shorthand commands.
4444
[run-s] is for sequential, [run-p] is for parallel.
4545
We can make simple plans with those commands.
4646

@@ -50,6 +50,36 @@ This `npm-run-all` package provides Node API.
5050

5151
- [Node API]
5252

53+
## Changelog
54+
55+
- https://github.com/mysticatea/npm-run-all/releases
56+
57+
## Contributing
58+
59+
Thank you for contributing!
60+
61+
### Bug Reports or Feature Requests
62+
63+
Please use GitHub Issues.
64+
65+
### Correct Documents
66+
67+
Please use GitHub Pull Requests.
68+
69+
I'm not familiar with English, so I especially thank you for documents' corrections.
70+
71+
### Feature Implementing
72+
73+
Please use GitHub Pull Requests.
74+
75+
There are some npm-scripts to help developments.
76+
Those work on Windows, Mac, or Linux (by the way, I'm developping `npm-run-all` on Windows).
77+
78+
- **npm test** - Run tests and collect coverage.
79+
- **npm run build** - Make `lib` directory from `src` directory.
80+
- **npm run clean** - Delete directories (folders) which are created by other commands.
81+
- **npm run lint** - Run ESLint.
82+
- **npm run watch** - Run tests (not collect coverage) when each file was modified.
5383

5484
[npm-run-all]: docs/npm-run-all.md
5585
[run-s]: docs/run-s.md

0 commit comments

Comments
 (0)