Skip to content

Commit f7d842f

Browse files
committed
Adjustment in READMEs
1 parent b793514 commit f7d842f

File tree

3 files changed

+70
-0
lines changed

3 files changed

+70
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,7 @@ npm init create-react-dependency my-dependency
3636

3737
- [Create React Dependency](https://github.com/andrelmlins/create-react-dependency/blob/master/packages/create-react-dependency/README.md)
3838
- [React Library Scripts](https://github.com/andrelmlins/create-react-dependency/blob/master/packages/react-dependency-scripts/README.md)
39+
40+
## License
41+
42+
Create React Dependency is open source software [licensed as MIT](https://github.com/andrelmlins/create-react-dependency/blob/master/LICENSE).
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
11
# Create React Dependency
22

33
[![npm version](https://badge.fury.io/js/create-react-dependency.svg)](https://www.npmjs.com/package/create-react-dependency)
4+
5+
## Basic Use
6+
7+
```
8+
npx create-react-dependency new my-dependency
9+
cd my-dependency
10+
npm start
11+
```
12+
13+
## How to create a dependency or library?
14+
15+
### Yarn
16+
17+
```
18+
yarn create create-react-dependency my-dependency
19+
```
20+
21+
### NPX
22+
23+
```
24+
npx create-react-dependency my-dependency
25+
```
26+
27+
### NPM
28+
29+
```
30+
npm init create-react-dependency my-dependency
31+
```
32+
33+
## License
34+
35+
Create React Dependency is open source software [licensed as MIT](https://github.com/andrelmlins/create-react-dependency/blob/master/LICENSE).
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
11
# React Dependency Scripts
22

33
[![npm version](https://badge.fury.io/js/react-dependency-scripts.svg)](https://www.npmjs.com/package/react-dependency-scripts)
4+
5+
## Start the project
6+
7+
Using [webpack](https://webpack.js.org/) with reference to folder `src/dev`.
8+
9+
```
10+
npm start
11+
// OR
12+
yarn start
13+
```
14+
15+
## Build the project
16+
17+
Using [babel](https://babeljs.io/) with reference to folder `src/lib`.
18+
19+
```
20+
npm build
21+
// OR
22+
yarn build
23+
```
24+
25+
## Test the project
26+
27+
Using [jest](https://jestjs.io/) with reference to folder `src/lib`. Is possible edit the test config in `package.json`.
28+
29+
```
30+
npm test
31+
// OR
32+
yarn test
33+
```
34+
35+
## License
36+
37+
Create React Dependency is open source software [licensed as MIT](https://github.com/andrelmlins/create-react-dependency/blob/master/LICENSE).

0 commit comments

Comments
 (0)