Add README

stormwarning · Nov 17, 2023 · 6440ce6 · 6440ce6
1 parent c19140a
commit 6440ce6
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/packages/changesets-changelog/README.md b/packages/changesets-changelog/README.md
@@ -0,0 +1,18 @@
+# @zazen/changesets-changelog
+
+> A simplified version of [@changesets/changelog-github](https://github.com/changesets/changesets/tree/main/packages/changelog-github).
+
+## Usage
+
+```shell
+npm install --save-dev @changesets/cli @zazen/changesets-changelog
+```
+
+Add the following to your `.changeset/config.json`:
+
+```json
+  "changelog": [
+    "@changesets/changelog-github",
+    { "repo": "org/repo" }
+  ],
+```