@procore/storybook-addon 4.7.1 → 4.7.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @procore/storybook-addon
 
+## 4.7.2
+
+### Patch Changes
+
+- b8fa116: - Reverts changes related 4.6.0 and 4.7.0 and 4.7.1 .These changes introduced breaking behavior for consumers and are being reverted to prepare for a major version release with proper migration path.
+
 ## 4.7.1
 
 ### Patch Changes
@@ -8,6 +14,10 @@
 
 ## 4.7.0
 
+### Deprecated
+
+Deprecated: resolution issue after Storybook v10 upgrade. Use 4.7.1.
+
 ### Minor Changes
 
 - 87aa6f4: [Upgrade Storybook to v10](https://storybook.js.org/docs/releases/migration-guide)

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 your addon sets:
+And add the addon to you addon sets:
 
 ```tsx
 module.exports = {
@@ -16,13 +16,11 @@ module.exports = {
 };
 ```
 
-This addon provides essential functionality and addons used across different apps at Procore.
+This simple addon adds 3 main addon used across different apps at Procore.
 
-## 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
+- [@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)
 
 ## Usage
 
@@ -35,12 +33,12 @@ This addon provides essential functionality and addons used across different app
 - 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.ts`. 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.js`. 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(),
@@ -53,7 +51,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({
@@ -105,4 +103,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` app.
+This addon should be tested by running `storybook` in `example-apps/react-ts` and `example-apps/react-core-scripts` apps.