Skip to content

Commit

Permalink
docs(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
unadlib committed Mar 31, 2024
1 parent 773f295 commit 2e03896
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -85,16 +85,16 @@ const App = () => {
};
```

### Options
### Parameters

| Options | type | description | default |
| Parameter | type | description | default |
| ----------------- | ------------- | ------------------------------------- | -------------------------------- |
| `maxHistory` | number | The maximum number of history to keep | 10 |
| `initialPatches` | TravelPatches | The initial patches | {patches: [],inversePatches: []} |
| `initialPosition` | number | The initial position of the state | 0 |
| `autoArchive` | boolean | Auto archive the state | true |

### Return
### Returns

| Return | type | description |
| --------------------- | ------------------------------ | ---------------------------------------------------------------------- |
Expand Down

0 comments on commit 2e03896

Please sign in to comment.