Skip to content

Commit 8b8b415

Browse files
Update README.md
1 parent de43643 commit 8b8b415

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { defineStepper } from "@stepperize/react";
3232
2. Define your steps:
3333

3434
```tsx
35-
const { Scoped, useStepper, steps } = defineStepper(
35+
const { Scoped, useStepper, steps, utils } = defineStepper(
3636
{ id: "step-1", title: "Step 1", description: "Description for step 1" },
3737
{ id: "step-2", title: "Step 2", description: "Description for step 2" },
3838
{ id: "step-3", title: "Step 3", description: "Description for step 3" },
@@ -64,6 +64,7 @@ Stepperize allows you to define a series of steps with unique IDs. When you crea
6464
- A `Scoped` component for context management
6565
- A `useStepper` hook for step control
6666
- An array of `steps` for rendering
67+
- An `utils` object with useful functions
6768

6869
The only required field for each step is the `id`. You can add any additional properties you need, and they'll be fully typesafe when using the hook.
6970

@@ -77,4 +78,4 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
7778

7879
## License
7980

80-
Stepperize is [MIT licensed](LICENSE).
81+
Stepperize is [MIT licensed](LICENSE).

0 commit comments

Comments
 (0)