Merge pull request #2 from vercel/tomknickman/turbo-4647-add-repository-docs

tknickman · web-flow · commit cde9dadcfc14 · 2025-04-04T10:19:21.000-04:00
chore(docs): add readme and contrib
diff --git a/.changeset/brave-heads-warn.md b/.changeset/brave-heads-warn.md
@@ -0,0 +1,5 @@
+---
+'@vercel/repository-dispatch': minor
+---
+
+Add documentation
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+# Release
+
+Releases are handled with changesets. To create a new release - run:
+
+```bash
+pnpm changeset
+```
+
+and follow the prompts. Commit the resulting changeset file and push it to the repository. Do not manually change the version of the package to be published. Changesets will automatically determine the correct version, and handle the release process.
diff --git a/README.md b/README.md
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+packages/repository-dispatch/README.md
diff --git a/packages/repository-dispatch/README.md b/packages/repository-dispatch/README.md
@@ -0,0 +1,5 @@
+# `@vercel/repository-dispatch`
+
+Utilities and types for working with [`repository_dispatch`](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#repository_dispatch) events triggered by Vercel.
+
+[Learn more](https://vercel.com/docs/git/vercel-for-github#repository-dispatch)
