Skip to content

Commit 74752db

Browse files
fix: minor fix in template package.json
1 parent 0ebc5ae commit 74752db

File tree

3 files changed

+32
-7
lines changed

3 files changed

+32
-7
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@
44
55
Create React Library with no build configuration.
66

7-
## Usage
8-
9-
```sh
10-
npx react-create-library my-library
11-
```
127

138
![react-create-library](https://raw.githubusercontent.com/wadehrarshpreet/react-create-library/master/assets/demo.svg?sanitize=true)
149

@@ -27,6 +22,30 @@ npx react-create-library my-library
2722
- [Jest](https://facebook.github.io/jest/) for testing
2823
- Working example setup using [create-react-app](https://github.com/facebook/create-react-app)
2924

25+
26+
## Install globally
27+
28+
This package requires node >= 8.
29+
30+
```sh
31+
npm install -g react-create-library
32+
```
33+
34+
## Usage
35+
36+
```sh
37+
react-create-library my-library
38+
```
39+
40+
## Using npx
41+
42+
```sh
43+
npx react-create-library my-library
44+
```
45+
46+
Interactive CLI, answer few questions and choose modules required for development.
47+
48+
3049
### CLI Options
3150

3251
```

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@
2222
"node": ">=8",
2323
"npm": ">=5"
2424
},
25-
"keywords": [],
25+
"keywords": [
26+
"react",
27+
"library",
28+
"boilerplate",
29+
"react-library-boilerplate",
30+
"react-library"
31+
],
2632
"author": "Arshpreet Wadehra <me@wadehrarshpreet.com>",
2733
"license": "MIT",
2834
"dependencies": {

template/default/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"homepage": "http://{{author}}.github.io/{{name}}",
55
{{/ifCond}}
66
"version": "0.0.1",
7-
"description": {{description}},
7+
"description": "{{description}}",
88
{{#ifCond author '!==' ''}}
99
"repository": {
1010
"type": "git",

0 commit comments

Comments
 (0)