diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b68d10..0112afb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,6 +30,7 @@ Add tests with your change: engines and tools are tested in plain Node, and a to ## Branches and releases - Branch from `dev` and open your pull request into `dev`. It runs `check` and gets a preview deploy, linked in a comment. +- The badge at the top of the README is the last `check` run on `main` (typecheck, tests, notices, build and the Docker image test). If it is red, `main` is broken: fix that before releasing. - A release is a pull request from `dev` into `main` that raises the version and adds its `CHANGELOG.md` section, both written by `yarn release patch|minor|major`. Merging it deploys ream.deityhub.com, tags the version and publishes the release notes and Docker image. See [docs/deploy.md](docs/deploy.md). ## Ground rules diff --git a/README.md b/README.md index 68f6292..8fd0915 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Ream +[![Build and test](https://github.com/Deityhub/ream/actions/workflows/web.yml/badge.svg?branch=main)](https://github.com/Deityhub/ream/actions/workflows/web.yml) + **Ream is the file toolkit that runs on your computer.** Convert, edit, compress and secure PDFs, images and Office documents in your browser, with more kinds of file on the way. Your files are opened and processed on your own device and never reach a server. No account, no uploads, no trackers, and it works offline. **Use it at [ream.deityhub.com](https://ream.deityhub.com).**