Skip to content

Commit dbc7c01

Browse files
committed
docs: update readme
1 parent 53de587 commit dbc7c01

File tree

5 files changed

+41
-7
lines changed

5 files changed

+41
-7
lines changed

.changeset/slick-falcons-punch.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@msw-dev-tool/react": patch
3+
---
4+
5+
Update readme

.changeset/sour-worlds-heal.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@msw-dev-tool/core": patch
3+
---
4+
5+
Update readme

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ This project uses pnpm workspaces.
1212

1313
| Project | Description |
1414
| ---------------- | ----------------------------------------------------------------------------------------------------- |
15+
| **docs** | The documentation of the library.
16+
| **core** | `@msw-dev-tool/core`: Core lib logic to control msw handlers |
17+
| **react** | `@msw-dev-tool/lib`: Implement of react UI |
1518
| **example** | A sample project to develop and test `msw-dev-tool`. You need to build `msw-dev-tool` before testing. |
16-
| **msw-dev-tool** | The source code of the library. |
17-
| **docs** | The documentation of the library. |
19+
| **msw-dev-tool** | The **LEGACY** source code of the library. |
20+
|

packages/core/README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# core
2-
- Internal logic of `msw-dev-tool`.
2+
3+
- Internal logic of `msw-dev-tool/react`.
34
- Manage core logic, type and schema.
45
- It is based on `zustand` and `msw`.
5-
- Getting ready!
6+
- Getting ready!
7+
8+
# Install
9+
10+
- npm:
11+
12+
```bash
13+
npm i @msw-dev-tool/core --save-dev
14+
```
15+
16+
- yarn:
17+
18+
```bash
19+
yarn add @msw-dev-tool/core --dev
20+
```
21+
22+
- pnpm:
23+
24+
```bash
25+
pnpm add @msw-dev-tool/core --save-dev
26+
```

packages/react/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33
- npm:
44

55
```bash
6-
npm i msw-dev-tool --save-dev
6+
npm i @msw-dev-tool/core @msw-dev-tool/react --save-dev
77
```
88

99
- yarn:
1010

1111
```bash
12-
yarn add msw-dev-tool --dev
12+
yarn add @msw-dev-tool/core @msw-dev-tool/react --dev
1313
```
1414

1515
- pnpm:
1616

1717
```bash
18-
pnpm add msw-dev-tool --save-dev
18+
pnpm add @msw-dev-tool/core @msw-dev-tool/react --save-dev
1919
```
2020

2121
# How to use?

0 commit comments

Comments
 (0)