Skip to content

Commit bd36095

Browse files
committed
Add usage doc
1 parent 29a42a4 commit bd36095

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.md

+27-8
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,43 @@ Start you project easily with the right tools and best practices.
1111
## Usage
1212

1313
```bash
14-
npx @kdcsoftware/create-nodejs package-name
14+
_ ______ ____ ____ __ _
15+
| |/ / _ \ / ___/ ___| ___ / _| |___ ____ _ _ __ ___
16+
| ' /| | | | | \___ \ / _ \| |_| __\ \ /\ / / _` | '__/ _ \
17+
| . \| |_| | |___ ___) | (_) | _| |_ \ V V / (_| | | | __/
18+
|_|\_\____/ \____|____/ \___/|_| \__| \_/\_/ \__,_|_| \___|
19+
20+
Usage: npx @kdcsoftware/create-nodejs package-name
21+
22+
Options:
23+
-V, --version output the version number
24+
--no-bundle do not bundle the build output
25+
-g, --git-origin <remote-url> add git remote url as origin
26+
-i, --info print environment debug info
27+
-h, --help display help for command
28+
29+
Example:
30+
npx @kdcsoftware/create-nodejs my-awesome-package
31+
1532
```
1633
1734
## What's included
1835
1936
### Packages Installed
2037
21-
- babel
22-
- eslint
23-
- prettier
24-
- jest
25-
- husky
26-
- lint-staged
38+
- [babel](https://babeljs.io/)
39+
- [eslint](https://eslint.org/)
40+
- [prettier](https://prettier.io/)
41+
- [jest](https://jestjs.io/)
42+
- [husky](https://github.com/typicode/husky)
43+
- [lint-staged](https://github.com/okonet/lint-staged)
44+
- [parcel](https://parceljs.org/)
2745
2846
### Scripts
2947
3048
- Build script
49+
- Bundler script
3150
- Sample test script
3251
- GitHub Actions for merging and publishing
33-
- Initialize git
52+
- Initialize git and add remote url
3453
- Add info in package.json

0 commit comments

Comments
 (0)