Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).**
Expand Down
Loading