diff --git a/ADDONS_SUPPORT.md b/ADDONS_SUPPORT.md new file mode 100644 index 000000000000..dfea9fc65522 --- /dev/null +++ b/ADDONS_SUPPORT.md @@ -0,0 +1,17 @@ +## Addon / Framework Support Table + +| |[React](app/react)|[React Native](app/react-native)|[Vue](app/vue)|[Angular](app/angular)| [Polymer](app/polymer)| +| ----------- |:-------:|:-------:|:-------:|:-------:|:-------:| +|[a11y](addons/a11y) |+| | | | | +|[actions](addons/actions) |+|+|+|+|+| +|[background](addons/background)|+| | | | | +|[centered](addons/centered) |+| |+| | | +|[events](addons/events) |+| | | | | +|[graphql](addons/graphql) |+| | | | | +|[info](addons/info) |+| | | | | +|[jest](addons/jest) |+| | | | | +|[knobs](addons/knobs) |+|+|+|+|+| +|[links](addons/links) |+|+|+|+| | +|[notes](addons/notes) |+| |+|+|+| +|[storyshots](addons/storyshots)|+|+|+|+| | +|[viewport](addons/viewport) |+| | | | | \ No newline at end of file diff --git a/README.md b/README.md index 858456edf667..cb9e0e0df125 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Storybook comes with a lot of [addons](https://storybook.js.org/addons/introduct - [Getting Started](#getting-started) - [Projects](#projects) - - [Main Projects](#main-projects) + - [Supported Frameworks](#supported-frameworks) - [Sub Projects](#sub-projects) - [Addons](#addons) - [Contributing](#contributing) @@ -64,12 +64,13 @@ For additional help, join us [in our Slack](https://now-examples-slackin-rrirkqo ## Projects -### Main Projects +### Supported Frameworks -- [Storybook for react](app/react) - Storybook for React components -- [Storybook for vue](app/vue) - Storybook for Vue components -- [Storybook for angular](app/angular) - Storybook for Angular components -- [Storybook for react-native](app/react-native) - Storybook for React-Native components +- [React](app/react) +- [React Native](app/react-native) +- [Vue](app/vue) +- [Angular](app/angular) +- [Polymer](app/angular) alpha ### Sub Projects @@ -88,6 +89,8 @@ For additional help, join us [in our Slack](https://now-examples-slackin-rrirkqo - [notes](addons/notes/) - Annotate storybook stories with notes - [options](addons/options/) - Customize the storybook UI in code +See [Addon / Framework Support Table](ADDONS_SUPPORT.md) + ## Contributing We welcome contributions to Storybook! diff --git a/ROADMAP.md b/ROADMAP.md index 9fa1de69561c..7ee33e46251d 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -57,7 +57,7 @@ That way you can write your stories how they are best, and preview them how you We believe in the power of react, and think it's the right choice for a lot of projects. But it's up to you and your team to decide your stack. -Unfortunately if you choose anything other then React or React-Native you can not use storybook. +Unfortunately if you choose anything not from the list of [supported frameworks](README.md#supported-frameworks) you can not use storybook. We want you to be able to use storybook with the framework / library of your choice.