chore(project): sync generated files

carbon-design-system · Jan 28, 2021 · 72b73e3 · 72b73e3
1 parent 9e24de3
commit 72b73e3
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 33 deletions.
diff --git a/packages/storybook-addon-carbon-theme/.npmignore b/packages/storybook-addon-carbon-theme/.npmignore
@@ -0,0 +1,4 @@
+**/__mocks__/**
+**/__tests__/**
+**/examples/**
+**/tasks/**
diff --git a/packages/storybook-addon-carbon-theme/README.md b/packages/storybook-addon-carbon-theme/README.md
@@ -1,23 +1,22 @@
-# Storybook addon for Carbon themes
+# @carbon/storybook-addon-theme
 
-This addon for storybook allows you to change the theme used with Carbon
-Components!
+> Carbon theme switcher for Storybook
 
-## Supports
+## Getting started
 
-- React
-- Vue
+To install `@carbon/storybook-addon-theme` in your project, you will need to run
+the following command using [npm](https://www.npmjs.com/):
 
-## Install
-
-```sh
-npm install @carbon/storybook-addon-theme
+```bash
+npm install -S @carbon/storybook-addon-theme
 ```
 
-## Requirements
+If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
+instead:
 
-- Use of Carbon Components
-- Use of Custom CSS Properties feature flag
+```bash
+yarn add @carbon/storybook-addon-theme
+```
 
 ## Usage
 
@@ -87,3 +86,13 @@ storiesOf('Component', module)
     },
   });
 ```
+
+## 🙌 Contributing
+
+We're always looking for contributors to help us fix bugs, build new features,
+or help us improve the project documentation. If you're interested, definitely
+check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀
+
+## 📝 License
+
+Licensed under the [Apache 2.0 License](/LICENSE).
diff --git a/packages/storybook-addon-carbon-theme/package.json b/packages/storybook-addon-carbon-theme/package.json
@@ -1,32 +1,43 @@
 {
   "name": "@carbon/storybook-addon-theme",
-  "version": "0.1.0",
   "description": "Carbon theme switcher for Storybook",
-  "keywords": [
-    "addon",
-    "carbon",
-    "theme",
-    "storybook"
-  ],
-  "homepage": "https://github.com/storybookjs/storybook#readme",
-  "bugs": "https://github.com/carbon-design-system/carbon/issues",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "main": "dist/react.js",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/carbon-design-system/carbon.git",
-    "directory": "packages/scss-generator"
+    "url": "https://github.com/carbon-design-system/carbon.git",
+    "directory": "packages/storybook-addon-carbon-theme"
   },
-  "license": "Apache-2.0",
-  "main": "dist/react.js",
+  "bugs": "https://github.com/carbon-design-system/carbon/issues",
+  "homepage": "https://github.com/storybookjs/storybook#readme",
   "files": [
     "dist/**/*",
     "README.md",
     "*.js"
   ],
+  "keywords": [
+    "addon",
+    "carbon",
+    "theme",
+    "storybook",
+    "ibm",
+    "carbon-design-system",
+    "components",
+    "react"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "clean": "rimraf dist",
     "build": "npm run clean && babel src --out-dir dist -s",
     "prepare": "npm run build"
   },
+  "peerDependencies": {
+    "react": "*",
+    "vue": "*"
+  },
   "dependencies": {
     "@storybook/addons": "5.3.19",
     "@storybook/api": "5.3.19",
@@ -38,16 +49,9 @@
     "core-js": "^3.0.1",
     "global": "^4.3.2"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "devDependencies": {
     "@babel/cli": "^7.10.0",
     "@babel/core": "^7.10.0",
     "@babel/preset-react": "^7.10.4"
-  },
-  "peerDependencies": {
-    "react": "*",
-    "vue": "*"
   }
 }