From d56402f25b68d78b5c28d84630326d7cdba0aa9f Mon Sep 17 00:00:00 2001
From: Chris Wilkinson <c.wilkinson@elifesciences.org>
Date: Mon, 4 Dec 2023 22:17:00 +0000
Subject: [PATCH] It now does something useful

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 054c771..51fc7e8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,40 @@
 # PREreview COAR Notify
 
-⚠️ This repo doesn't yet do anything useful.
+The source code for PREreview’s [COAR Notify] integration.
+
+## Development
+
+<details>
+
+<summary>Requirements</summary>
+
+- [Docker]
+- [Docker Compose]
+- [GNU Make]
+- [Node.js]
+- Unix-like operating system
+
+</details>
+
+### Running the app
+
+To build and run the app for development, execute:
+
+```shell
+make start
+```
+
+You can now access the app at <https://localhost:3000>.
+
+You will also have a `.env` file. This file contains environment variables controlling specific behaviours, including credentials for accessing external services.
+
+## Operations
+
+Once it passes CI, we deploy every commit on the `main` branch, which [Fly.io] hosts.
+
+[coar notify]: https://www.coar-repositories.org/notify/
+[docker]: https://www.docker.com/
+[docker compose]: https://docs.docker.com/compose/
+[fly.io]: https://fly.io/
+[gnu make]: https://www.gnu.org/software/make/
+[node.js]: https://nodejs.org/