From 2e03896018460b08c698cad98ebde6a3fbe74fa7 Mon Sep 17 00:00:00 2001 From: unadlib Date: Mon, 1 Apr 2024 00:00:22 +0800 Subject: [PATCH] docs(readme): update --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bd95d16..ce10fcb 100644 --- a/README.md +++ b/README.md @@ -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 | | --------------------- | ------------------------------ | ---------------------------------------------------------------------- |