-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
10 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,19 +28,25 @@ | |
|
||
## Requirements | ||
|
||
- Storybook@>=5.0.0 | ||
|
||
This addon should work with any framework. If you find a case that the addon does not work, please open an issue. | ||
Storybook Zeplin addon v3 is compatible with Storybook 8 and Node Version >18. | ||
For Storybook versions 5-7, please use Storybook Zeplin addon v2.0.3 | ||
|
||
## Getting started | ||
|
||
### 1. Install | ||
|
||
For using Storybook 8: | ||
```sh | ||
npm install --save-dev storybook-zeplin | ||
# yarn add -D storybook-zeplin | ||
``` | ||
|
||
For using Storybook version 5-7: | ||
```sh | ||
npm install --save-dev [email protected] | ||
# yarn add -D [email protected] | ||
``` | ||
|
||
### 2. Register the addon in `main.js` | ||
|
||
```js | ||
|
@@ -50,7 +56,7 @@ module.exports = { | |
}; | ||
``` | ||
|
||
If you're using [email protected]; | ||
If you're using [email protected]: | ||
|
||
```js | ||
// .storybook/addons.js | ||
|