Skip to content

Commit

Permalink
docs: update readme (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
alcpereira authored Jul 27, 2024
1 parent 0689109 commit 63c89bc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ The repository contains the Storybook Rsbuild builder and framework integrations
> [!IMPORTANT]
> Peer dependencies requirements:
>
> - **`@rsbuild/core >= 1.0.0-alpha.9`**: Rsbuild is about to release version 1.0.0, and the current alpha version is already very reliable. (checkout Rsbuild's [1.0.0 breaking changes](https://github.com/web-infra-dev/rsbuild/discussions/2508))
> - **`storybook >= 8.2.1`**: Storybook made some internal refactor in major version, 8.2.1 is tested out. (checkout Storybook's [release note](https://storybook.js.org/blog/storybook-8/) for migrating from v7)
> - **`@rsbuild/core >= 1.0.0-alpha.9`**: Rsbuild is about to release version 1.0.0, and the current alpha version is already very reliable. (check out Rsbuild's [1.0.0 breaking changes](https://github.com/web-infra-dev/rsbuild/discussions/2508))
> - **`storybook >= 8.2.1`**: Storybook made some internal refactor in major version, 8.2.1 is tested out. (check out Storybook's [release note](https://storybook.js.org/blog/storybook-8/) for migrating from v7)
In Storybook v8, you don't need to manually install storybook-builder-rsbuild, it has been depended by the framework, such as `storybook-react-rsbuild` and `storybook-vue3-rsbuild`.

Expand All @@ -48,7 +48,7 @@ In Storybook v8, you don't need to manually install storybook-builder-rsbuild, i
export default config;
```

You're all set now. You could also checkout the example in [sandboxes/react-rsbuild](./sandboxes/react-rsbuild) and use all other features listed in [Storybook site](https://storybook.js.org/docs).
You're all set now. You could also check out the example in [sandboxes/react-18](./sandboxes/react-18) and use all other features listed in [Storybook site](https://storybook.js.org/docs).

### Use with Vue 3 (in a existing Rsbuild project)

Expand All @@ -72,7 +72,7 @@ You're all set now. You could also checkout the example in [sandboxes/react-rsbu
export default config;
```

You're all set now. You could also checkout the example in [sandboxes/vue3-rsbuild](./sandboxes/vue3-rsbuild) and use all other features listed in [Storybook site](https://storybook.js.org/docs).
You're all set now. You could also check out the example in [sandboxes/vue3-rsbuild](./sandboxes/vue3-rsbuild) and use all other features listed in [Storybook site](https://storybook.js.org/docs).

### Builder options

Expand Down

0 comments on commit 63c89bc

Please sign in to comment.