Skip to content

Commit

Permalink
Update README.md for addon v3
Browse files Browse the repository at this point in the history
  • Loading branch information
jharsono authored Jul 12, 2024
1 parent 4022087 commit b0e2d86
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -50,7 +56,7 @@ module.exports = {
};
```

If you're using [email protected];
If you're using [email protected]:

```js
// .storybook/addons.js
Expand Down

0 comments on commit b0e2d86

Please sign in to comment.