Skip to content

Commit

Permalink
Merge pull request #1380 from storybooks/readme-update
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
usulpro committed Jun 29, 2017
2 parents cfa20f9 + ee3e992 commit d6f791c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ It allows you to browse a component library, view the different states of each c

Storybook runs outside of your app. This allows you to develop UI components in isolation, which can improve component reuse, testability, and development speed. You can build quickly without having to worry about application-specific dependencies.

Here are some featured examples that you can reference to see how Storybook works: https://storybook.js.org/examples/

Storybook comes with a lot of [addons](https://storybook.js.org/addons/introduction/) for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile.

## Table of contents
Expand All @@ -45,6 +47,14 @@ getstorybook

Once it's installed, you can `npm run storybook` and it will run the development server on your local machine, and give you a URL to browse some sample stories.

**Storybook v2.x migration note**: If you're using Storybook v2.x and want to shift to 3.x version the easiest way is:
```sh
npm i -g @storybook/cli
cd my-storybook-v2-app
getstorybook
```
It runs a codemod to update all package names. Read all migration details in our [Migration Guide](MIGRATION.md)

For full documentation on using Storybook visit: [storybook.js.org](https://storybook.js.org)

## Projects
Expand All @@ -63,6 +73,7 @@ For full documentation on using Storybook visit: [storybook.js.org](https://stor

- [storyshots](addons/storyshots) - Easy snapshot testing for storybook
- [actions](addons/actions/) - Log actions as users interact with components in storybook
- [links](addons/links/) - Create links between stories
- [comments](addons/comments/) - Comment on storybook stories
- [graphql](addons/graphql/) - Query a GraphQL server within Storybook stories
- [info](addons/info/) - Annotate stories with extra component usage information
Expand Down

0 comments on commit d6f791c

Please sign in to comment.