Skip to content

Commit

Permalink
docs(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
unadlib committed May 19, 2024
1 parent 79aa600 commit f60e498
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# useMutative

![Node CI](https://github.com/unadlib/use-mutative/workflows/Node%20CI/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/unadlib/use-mutative/badge.svg?branch=main)](https://coveralls.io/github/unadlib/use-mutative?branch=main)
![Node CI](https://github.com/mutativejs/use-mutative/workflows/Node%20CI/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/mutativejs/use-mutative/badge.svg?branch=main)](https://coveralls.io/github/mutativejs/use-mutative?branch=main)
[![npm](https://img.shields.io/npm/v/use-mutative.svg)](https://www.npmjs.com/package/use-mutative)
![license](https://img.shields.io/npm/l/use-mutative)

A hook to use [Mutative](https://github.com/unadlib/mutative) as a React hook to efficient update react state immutable with mutable way.
A hook to use [Mutative](https://github.com/mutativejs/mutative) as a React hook to efficient update react state immutable with mutable way.

`useMutative` is 2-6x faster than `useState()` with spread operation, more than 10x faster than `useImmer()`. [Read more about the performance comparison in Mutative](https://mutative.js.org/docs/getting-started/performance).

Expand Down Expand Up @@ -110,7 +110,7 @@ export function App() {
}
```

More detail about `use-mutative` can be found in [API docs](https://github.com/unadlib/use-mutative/blob/main/docs/modules.md)
More detail about `use-mutative` can be found in [API docs](https://github.com/mutativejs/use-mutative/blob/main/docs/modules.md)

### Patches

Expand All @@ -133,4 +133,4 @@ patches format will follow https://jsonpatch.com/, but the `"path"` field be arr

## License

`use-mutative` is [MIT licensed](https://github.com/unadlib/use-mutative/blob/main/LICENSE).
`use-mutative` is [MIT licensed](https://github.com/mutativejs/use-mutative/blob/main/LICENSE).
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ use-mutative / [Exports](modules.md)

# useMutative

![Node CI](https://github.com/unadlib/use-mutative/workflows/Node%20CI/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/unadlib/use-mutative/badge.svg?branch=main)](https://coveralls.io/github/unadlib/use-mutative?branch=main)
![Node CI](https://github.com/mutativejs/use-mutative/workflows/Node%20CI/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/mutativejs/use-mutative/badge.svg?branch=main)](https://coveralls.io/github/mutativejs/use-mutative?branch=main)
[![npm](https://img.shields.io/npm/v/use-mutative.svg)](https://www.npmjs.com/package/use-mutative)
![license](https://img.shields.io/npm/l/use-mutative)

A hook to use [Mutative](https://github.com/unadlib/mutative) as a React hook to efficient update react state immutable with mutable way.
A hook to use [Mutative](https://github.com/mutativejs/mutative) as a React hook to efficient update react state immutable with mutable way.

`useMutative` is 2-6x faster than `useState` with spread operation, more than 10x faster than `useImmer`. [Read more about the performance comparison in Mutative](https://mutative.js.org/docs/getting-started/performance).
`useMutative` is 2-6x faster than `useState()` with spread operation, more than 10x faster than `useImmer()`. [Read more about the performance comparison in Mutative](https://mutative.js.org/docs/getting-started/performance).

## Installation

Expand Down Expand Up @@ -111,7 +111,7 @@ export function App() {
}
```

More detail about `use-mutative` can be found in [API docs](https://github.com/unadlib/use-mutative/blob/main/docs/modules.md)
More detail about `use-mutative` can be found in [API docs](https://github.com/mutativejs/use-mutative/blob/main/docs/modules.md)

### Patches

Expand All @@ -134,4 +134,4 @@ patches format will follow https://jsonpatch.com/, but the `"path"` field be arr

## License

`use-mutative` is [MIT licensed](https://github.com/unadlib/use-mutative/blob/main/LICENSE).
`use-mutative` is [MIT licensed](https://github.com/mutativejs/use-mutative/blob/main/LICENSE).
14 changes: 7 additions & 7 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

#### Defined in

[index.ts:30](https://github.com/unadlib/use-mutative/blob/20d919b/src/index.ts#L30)
[index.ts:31](https://github.com/mutativejs/use-mutative/blob/79aa600/src/index.ts#L31)

___

Expand Down Expand Up @@ -75,7 +75,7 @@ ___

#### Defined in

[index.ts:109](https://github.com/unadlib/use-mutative/blob/20d919b/src/index.ts#L109)
[index.ts:152](https://github.com/mutativejs/use-mutative/blob/79aa600/src/index.ts#L152)

___

Expand Down Expand Up @@ -105,7 +105,7 @@ ___

#### Defined in

[index.ts:31](https://github.com/unadlib/use-mutative/blob/20d919b/src/index.ts#L31)
[index.ts:32](https://github.com/mutativejs/use-mutative/blob/79aa600/src/index.ts#L32)

## Functions

Expand Down Expand Up @@ -154,7 +154,7 @@ expect(nextState).toEqual({ items: [1, 2] });

#### Defined in

[index.ts:64](https://github.com/unadlib/use-mutative/blob/20d919b/src/index.ts#L64)
[index.ts:65](https://github.com/mutativejs/use-mutative/blob/79aa600/src/index.ts#L65)

___

Expand Down Expand Up @@ -218,7 +218,7 @@ expect(result.current[0]).toEqual({ count: 1 });

#### Defined in

[index.ts:111](https://github.com/unadlib/use-mutative/blob/20d919b/src/index.ts#L111)
[index.ts:154](https://github.com/mutativejs/use-mutative/blob/79aa600/src/index.ts#L154)

**useMutativeReducer**\<`S`, `A`, `I`, `F`, `O`\>(`reducer`, `initializerArg`, `initializer`, `options?`): `ReducerResult`\<`S`, `A`, `O`, `F`\>

Expand Down Expand Up @@ -278,7 +278,7 @@ expect(result.current[0]).toEqual({ count: 1 });

#### Defined in

[index.ts:124](https://github.com/unadlib/use-mutative/blob/20d919b/src/index.ts#L124)
[index.ts:167](https://github.com/mutativejs/use-mutative/blob/79aa600/src/index.ts#L167)

**useMutativeReducer**\<`S`, `A`, `F`, `O`\>(`reducer`, `initialState`, `initializer?`, `options?`): `ReducerResult`\<`S`, `A`, `O`, `F`\>

Expand Down Expand Up @@ -337,4 +337,4 @@ expect(result.current[0]).toEqual({ count: 1 });

#### Defined in

[index.ts:137](https://github.com/unadlib/use-mutative/blob/20d919b/src/index.ts#L137)
[index.ts:180](https://github.com/mutativejs/use-mutative/blob/79aa600/src/index.ts#L180)
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/unadlib/use-mutative.git"
"url": "git+https://github.com/mutativejs/use-mutative.git"
},
"author": "unadlib",
"license": "MIT",
"bugs": {
"url": "https://github.com/unadlib/use-mutative/issues"
"url": "https://github.com/mutativejs/use-mutative/issues"
},
"homepage": "https://github.com/unadlib/use-mutative#readme",
"homepage": "https://github.com/mutativejs/use-mutative#readme",
"keywords": [
"react",
"hook",
Expand Down

0 comments on commit f60e498

Please sign in to comment.