@procore/storybook-addon 4.7.2 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @procore/storybook-addon
 
+## 5.0.0
+
+### Major Changes
+
+- 5544bb4: upgrade Storybook to v9
+- 87aa6f4: [Upgrade Storybook to v10](https://storybook.js.org/docs/releases/migration-guide)
+
 ## 4.7.2
 
 ### Patch Changes

package/README.md

@@ -8,7 +8,7 @@ An addon to customize procore theme and adds common used configuration.
 yarn add -D @procore/storybook-addon
 ```
 
-And add the addon to you addon sets:
+And add the addon to your addon sets:
 
 ```tsx
 module.exports = {
@@ -16,11 +16,13 @@ module.exports = {
 };
 ```
 
-This simple addon adds 3 main addon used across different apps at Procore.
+This addon provides essential functionality and addons used across different apps at Procore.
 
-- [@storybook/addon-essentials](https://storybook.js.org/addons/tag/essentials/)
-- [@storybook/addon-storysource](https://storybook.js.org/addons/@storybook/addon-storysource)
-- [@storybook/addon-a11y](https://storybook.js.org/addons/@storybook/addon-a11y)
+## Included Addons
+
+- [@storybook/addon-docs](https://storybook.js.org/addons/@storybook/addon-docs) - Documentation and documentation controls
+- [@storybook/addon-a11y](https://storybook.js.org/addons/@storybook/addon-a11y) - Accessibility testing addon
+- [@storybook/addon-styling-webpack](https://storybook.js.org/addons/@storybook/addon-styling-webpack) - Webpack styling configuration
 
 ## Usage
 
@@ -33,12 +35,12 @@ This simple addon adds 3 main addon used across different apps at Procore.
 - a hower text ${\text{\color{green}{Core}}}$
 - the link to core design system [https://design.procore.com](https://design.procore.com) on the logo.
 
-In order to set the theme by default values ${\text{\color{green}{createProcoreTheme}}}$ needs to be added in `manager.js`. If no parameter has been passed to the `createProcoreTheme` the aforementioned default values will be set.
+In order to set the theme by default values ${\text{\color{green}{createProcoreTheme}}}$ needs to be added in `manager.ts`. If no parameter has been passed to the `createProcoreTheme` the aforementioned default values will be set.
 
 ```tsx
 // .storybook/manager.js
 import { createProcoreTheme } from '@procore/storybook-addon';
-import { addons } from '@storybook/manager-api';
+import { addons } from 'storybook/manager-api';
 
 addons.setConfig({
   theme: createProcoreTheme(),
@@ -51,7 +53,7 @@ For more configuration please visit: https://storybook.js.org/docs/react/configu
 // .storybook/manager.js
 // example below will override Procore default theming configuration
 import { createProcoreTheme } from '@procore/storybook-addon';
-import { addons } from '@storybook/manager-api';
+import { addons } from 'storybook/manager-api';
 
 addons.setConfig({
   theme: createProcoreTheme({
@@ -103,4 +105,4 @@ Please refer to [Storybook Docs](https://storybook.js.org/docs/react/configure/o
 
 ## Testing
 
-This addon should be tested by running `storybook` in `example-apps/react-ts` and `example-apps/react-core-scripts` apps.
+This addon should be tested by running `storybook` in `example-apps/react-ts` app.