Merge pull request #3 from kemuridama/v1.0.0

Release v1.0.0
kemuridama · Jul 1, 2023 · b1edd5f · b1edd5f
2 parents 3c7c313 + 5dbe529
commit b1edd5f
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 135 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,33 @@
 # storybook-addon-github
 
 A Storybook addon that allows you to link a source code of your story on GitHub.
+
+## Installation
+
+```
+npm i -D @kemuridama/storybook-addon-github
+```
+
+## Configuration
+
+Add the following to your `.storybook/main.js`:
+
+```
+export default {
+  addons: ['@kemuridama/storybook-addon-github'],
+}
+```
+
+Then, add the following to your `.storybook/preview.js`:
+
+```
+export default {
+  parameters: {
+    github: {
+      baseURL: "<GitHub Enterprise Server URL (optional)>",
+      repository: "<repository name>",
+      branch: "<branch name>",
+    }
+  }
+}
+```