Skip to content

Commit 1082b46

Browse files
authored
update README (#5)
* update README * update README
1 parent 3a98507 commit 1082b46

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,28 @@
11
# rc-mutate-observer
22

3-
React 18 supported Portal Component.
3+
MutateObserver for React.
44

55
[![NPM version][npm-image]][npm-url] [![dumi](https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square)](https://github.com/umijs/dumi) [![build status][github-actions-image]][github-actions-url] [![Codecov][codecov-image]][codecov-url] [![npm download][download-image]][download-url]
66

7-
[npm-image]: http://img.shields.io/npm/v/rc-portal.svg?style=flat-square
8-
[npm-url]: http://npmjs.org/package/rc-portal
9-
[github-actions-image]: https://github.com/react-component/portal/workflows/CI/badge.svg
10-
[github-actions-url]: https://github.com/react-component/portal/actions
11-
[codecov-image]: https://img.shields.io/codecov/c/github/react-component/portal/master.svg?style=flat-square
12-
[codecov-url]: https://codecov.io/gh/react-component/portal/branch/master
13-
[download-image]: https://img.shields.io/npm/dm/rc-portal.svg?style=flat-square
14-
[download-url]: https://npmjs.org/package/rc-portal
7+
[npm-image]: http://img.shields.io/npm/v/@rc-component/mutate-observer.svg?style=flat-square
8+
[npm-url]: https://www.npmjs.com/package/@rc-component/mutate-observer
9+
[github-actions-image]: https://github.com/react-component/mutate-observer/workflows/CI/badge.svg
10+
[github-actions-url]: https://github.com/react-component/mutate-observer/actions
11+
[codecov-image]: https://img.shields.io/codecov/c/github/@rc-component/mutate-observer/master.svg?style=flat-square
12+
[download-image]: https://img.shields.io/npm/dm/@rc-component/mutate-observer.svg?style=flat-square
13+
[download-url]: https://www.npmjs.com/package/@rc-component/mutate-observer
1514

1615
## Development
1716

1817
```bash
1918
npm install
20-
npm start
19+
npm run start
2120
open http://localhost:8000
2221
```
2322

24-
## Feature
25-
26-
- React life cycle support portal component
27-
2823
## Install
2924

30-
[![rc-portal](https://nodei.co/npm/rc-portal.png)](https://npmjs.org/package/rc-portal)
25+
[![@rc-component/mutate-observer](https://nodei.co/npm/mutate-observer.png)](https://www.npmjs.com/package/@rc-component/mutate-observer)
3126

3227
## Usage
3328

@@ -53,9 +48,9 @@ export default Demo;
5348

5449
## 🔥 API
5550

56-
We use typescript to create the Type definition. You can view directly in IDE. But you can still check the type definition [here](https://github.com/react-component/portal/blob/master/src/interface.ts).
51+
We use typescript to create the Type definition. You can view directly in IDE. But you can still check the type definition [here](https://github.com/react-component/mutate-observer/blob/master/src/interface.ts).
5752

58-
### Portal
53+
### mutate-observer
5954

6055
| Prop | Description | Type | Default |
6156
| -------- | ---------------------------------------------------------------------------------------------------------------- | -------------------- | ------- |

0 commit comments

Comments
 (0)