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 c2446d7 commit a67d881
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# use-travel

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

A React hook for state time travel with undo, redo, reset and archive functionalities.

### Motivation

`use-travel` is a small and high-performance library for state time travel. It's built on [Mutative](https://github.com/unadlib/mutative) to support mutation updating immutable data. It's designed to be simple and easy to use, and it's also customizable for different use cases.
`use-travel` is a small and high-performance library for state time travel. It's built on [Mutative](https://github.com/mutativejs/mutative) to support mutation updating immutable data. It's designed to be simple and easy to use, and it's also customizable for different use cases.

It's suitable for building any time travel feature in your application.

Expand Down Expand Up @@ -127,4 +127,4 @@ const [state, setState, controls] = useTravel(initialState, {

## License

`use-travel` is [MIT licensed](https://github.com/unadlib/use-travel/blob/main/LICENSE).
`use-travel` is [MIT licensed](https://github.com/mutativejs/use-travel/blob/main/LICENSE).
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/unadlib/use-travel.git"
"url": "git+https://github.com/mutativejs/use-travel.git"
},
"author": "unadlib",
"license": "MIT",
"bugs": {
"url": "https://github.com/unadlib/use-travel/issues"
"url": "https://github.com/mutativejs/use-travel/issues"
},
"homepage": "https://github.com/unadlib/use-travel#readme",
"homepage": "https://github.com/mutativejs/use-travel#readme",
"keywords": [
"use-undo",
"undo",
Expand Down

0 comments on commit a67d881

Please sign in to comment.