From f16d94c60b5143740af3ea6c95ac31fc6d576ac1 Mon Sep 17 00:00:00 2001 From: Andrew Lisowski Date: Thu, 14 Mar 2019 11:11:24 -0700 Subject: [PATCH] update readme --- addons/notes/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/addons/notes/README.md b/addons/notes/README.md index 0382a2a8cf9..2d243de8000 100644 --- a/addons/notes/README.md +++ b/addons/notes/README.md @@ -19,7 +19,10 @@ Then create a file called `addons.js` in your storybook config. Add following content to it: ```js +// register the notes addon as a tab import '@storybook/addon-notes/register'; +// register the notes addon as a panel +import '@storybook/addon-notes/register-panel'; ``` You can use the `notes` parameter to add a note to each story: @@ -29,10 +32,9 @@ import { storiesOf } from '@storybook/react'; import Component from './Component'; -storiesOf('Component', module) - .add('with some emoji', () => , { - notes: 'A very simple example of addon notes', - }); +storiesOf('Component', module).add('with some emoji', () => , { + notes: 'A very simple example of addon notes', +}); ``` #### Using Markdown @@ -44,8 +46,7 @@ import { storiesOf } from '@storybook/react'; import Component from './Component'; import notes from './someMarkdownText.md'; -storiesOf('Component', module) - .add('With Markdown', () => , { notes }); +storiesOf('Component', module).add('With Markdown', () => , { notes }); ``` ### Giphy @@ -57,4 +58,3 @@ When using markdown, you can also embed gifs from Giphy into your markdown. Curr ``` -