Skip to content

Commit

Permalink
Merge pull request #1835 from crtvhd/patch-1
Browse files Browse the repository at this point in the history
Update README: mention that addon-links needs to be registered manually
  • Loading branch information
Hypnosphi authored Sep 12, 2017
2 parents 3bdf6c2 + 242cb8a commit 4664bf9
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion addons/links/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,18 @@ This addon works with Storybook for:

## Getting Started

You can use this addon without installing it.
Install this addon by adding the `@storybook/addon-links` dependency:
```sh
yarn add @storybook/addon-links
```

First configure it as an addon by adding it to your addons.js file (located in the Storybook config directory).

```js
import '@storybook/addon-links/register';
```

Then you can import `linkTo` in your stories and use like this:

```js
import { storiesOf } from '@storybook/react'
Expand Down

0 comments on commit 4664bf9

Please sign in to comment.