diff --git a/.github/workflows/prereleases.yml b/.github/workflows/prereleases.yml index c5b1d501..a52603a2 100644 --- a/.github/workflows/prereleases.yml +++ b/.github/workflows/prereleases.yml @@ -1,6 +1,10 @@ name: Publish prereleases -on: pull_request +on: + push: + branches: [main, experimental] + pull_request: + branches: [main, experimental] jobs: release: diff --git a/README.md b/README.md index 48d27943..4bb09516 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,25 @@ The repository contains two directories: - `packages` containing a cloudflare package that can be used to build a Cloudflare Workers-compatible output for Next.js applications. - `examples` containing Next.js applications that use the above mentioned cloudflare package. -### How to try out/develop in the repository +### How to try out the `@opennextjs/cloudflare` package + +You can simply install the package from npm as specified in the [OpenNext documentation](https://opennext.js.org/cloudflare/get-started). + +#### Preleases + +Besides the standard npm releases we also automatically publish prerelease packages on branch pushes (using [`pkg.pr.new`](https://github.com/stackblitz-labs/pkg.pr.new)): + +- `https://pkg.pr.new/@opennextjs/cloudflare@main`: + Updated with every push to the `main` branch, this prerelease contains the most up to date yet (reasonably) stable version of the package. +- `https://pkg.pr.new/@opennextjs/cloudflare@experimental` + Updated with every push to the `experimental` branch, this prerelease contains the latest experimental version of the package (containing features that we want to test/experiment on before committing to). + +Which you can simply install directly with your package manager of choice, for example: + +```bash +npm i https://pkg.pr.new/@opennextjs/cloudflare@main +``` + +### How to develop in the repository See the [CONTRIBUTING](./CONTRIBUTING.md) page for how to get started with this repository.