From 5987af34cfe9f872c44bd9efd581b23568b613c4 Mon Sep 17 00:00:00 2001
From: Andrew Hosgood <andrew.hosgood@nationalarchives.gov.uk>
Date: Tue, 7 Jan 2025 09:58:19 +0000
Subject: [PATCH] Update README.md

---
 README.md | 61 +++++++++++++++----------------------------------------
 1 file changed, 16 insertions(+), 45 deletions(-)

diff --git a/README.md b/README.md
index f4baf1d9d..08469951c 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,30 @@
-# Etna
+# TNA Wagtail CMS
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
-## Project documentation
-
-This project contains technical documentation written in Markdown in the /docs folder. The latest build (from the `develop` branch) can be viewed online at:
-https://nationalarchives.github.io/ds-wagtail/
-
-You can also view it locally on http://localhost:8001/ which is booted as the `docs` container.
-
-## Setting up a local build
-
-Local development is done in Docker. You can [find out more about this here](https://nationalarchives.github.io/ds-wagtail/developer-guide/project-conventions/).
-
-Convenience commands have been added to `fabfile.py` to help you interact with the various services. But, for any of these commands to work, you must first [install Fabric](https://www.fabfile.org/installing.html).
-
-Once installed, you can type `fab -l` to see a list of available commands.
-
-### Before starting a build for the first time
+## Quickstart
 
 ```sh
+# Copy the example .env file
 cp .env.example .env
-```
-
-Populate values for:
 
-- `KONG_CLIENT_BASE_URL`
-- `KONG_IMAGE_PREVIEW_BASE_URL`
-- `KONG_CLIENT_KEY`
-- `PLATFORMSH_CLI_TOKEN`
+# Set .env values for:
+#   - KONG_CLIENT_BASE_URL
+#   - KONG_IMAGE_PREVIEW_BASE_URL
+#   - KONG_CLIENT_KEY
+#   - PLATFORMSH_CLI_TOKEN
 
-### 1. Build and start Docker containers
-
-```sh
+# Build and start the containers
 docker compose up -d
 ```
 
-### 2. Access the site
+View the site on [localhost:8000](http://localhost:8000).
 
-<http://127.0.0.1:8000>
+Log in to the Wagtail Admin on [localhost:8000/admin](http://localhost:8000/admin) with the credentials:
 
-### 3. Access the Wagtail admin
+- Username: `admin`
+- Password: `admin`
 
-Navigate to the admin URL in your browser, and sign in using the username/password combination you chose in the previous step.
-
-<http://127.0.0.1:8000/admin/>
-
-## Issues with your local environment?
-
-Check out the [Local development gotchas](https://nationalarchives.github.io/ds-wagtail/developer-guide/local-development-gotchas/) page for solutions to common issues.
+## Project documentation
 
-## Discover more
+This project contains technical documentation written in Markdown in the `/docs` folder. The latest build from the working branch can be viewed online at [nationalarchives.github.io/ds-wagtail](https://nationalarchives.github.io/ds-wagtail/).
 
-- [Documentation home](https://nationalarchives.github.io/ds-wagtail/)
-- [Project conventions](https://nationalarchives.github.io/ds-wagtail/developer-guide/project-conventions/)
-- [Backend development guide](https://nationalarchives.github.io/ds-wagtail/developer-guide/backend/)
-- [Frontend development guide](https://nationalarchives.github.io/ds-wagtail/developer-guide/frontend/)
-- [Fetching data](https://nationalarchives.github.io/ds-wagtail/developer-guide/fetching-data/)
+You can also view it locally on http://localhost:8001/ which is served from the `docs` container.