Update readme

Author: edwardhorsford

README.md

@@ -1,69 +1,41 @@
-# NHS.UK prototype kit
+# NHS Screening event management prototype
 
-Visit the <a href="https://prototype-kit.service-manual.nhs.uk">NHS.UK prototype kit site</a> to download the latest version and read the documentation.
+A prototype for managing breast screening clinics and participants, built using the [NHS.UK prototype kit](https://prototype-kit.service.manual.nhs.uk).
 
-## About the NHS.UK prototype kit
+## About this prototype
 
-The NHS.UK prototype kit enables you to make interactive prototypes that will look like pages on NHS.UK. The prototypes you make are a great way to show ideas to others and for conducting user research.
+This prototype demonstrates a system for managing breast screening clinics, including:
+- Viewing and managing daily clinic lists
+- Tracking participants through their screening journey
+- Managing participant information and status
 
-## Security
-
-If you publish your prototypes online, they must be protected by a <a href="https://prototype-kit.service-manual.nhs.uk/how-tos/publish-your-prototype-online">username and password</a>. This is to prevent members of the public finding prototypes and thinking they are real services.
-
-You must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like NHS.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately.
-
-## Installation instructions
-
-- <a href="https://prototype-kit.service-manual.nhs.uk/install/simple">Install guide (non technical)</a>
-- <a href="https://prototype-kit.service-manual.nhs.uk/install/advanced">Developer friendly install guide (technical)</a>
-
-### Running the kit
-
-Start the kit with `npm run watch`.
-
-## Contribute
-
-If you want to contribute to the NHS.UK prototype kit, by reporting bugs, fixing bugs, suggesting new features or writing documentation, then read our [contributing guidelines](CONTRIBUTING.md).
+The prototype includes auto-generated example data to demonstrate the interactions and user journeys.
 
-## Development environment
+## Installation
 
-Before running Gitpod, you must <a href="https://github.com/apps/gitpod-io/installations/new">install the Gitpod.io application on your GitHub account</a>.
+1. Follow the [NHS.UK prototype kit installation guide](https://prototype-kit.service.manual.nhs.uk/install/simple)
+2. Clone this repository
+3. Run `npm install`
+4. Run `npm run watch`
 
-Gitpod also requires access to public repositories. Enable this via <a href="https://gitpod.io/integrations">Gitpod integrations</a>. (Click on the 3 dots to edit permissions for your GitHub account. Gitpod may pre-select permissions. You need read/write access to code in the repos.)
+The prototype will generate example data on first run.
 
-Using your own GitHub credentials you can create, change, commit and push to branches on our Gitpod container via the "ready to code" button below.
+## Features
 
-[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/nhsuk/nhsuk-prototype-kit)
+- View all clinics or today's clinics
+- View clinic details and participant lists
+- Track participant status through their screening journey
+- View participant details within clinic context
 
-Read an <a href="https://www.gitpod.io/docs">introduction to Gitpod (on Gitpod's website)</a>.
+## Development notes
 
-## Release lifecycle
+- Example data is auto-generated in `app/data/generated`
+- Delete the generated folder to regenerate fresh example data
+- You can also run the generator directly with `node app/lib/generate-seed-data.js`
+- Uses NHS.UK design system components and patterns
 
-> The below is only for maintainers of the prototype kit source code - these instructions aren't relevant if you're building your own prototype using the kit.
-
-### Testing
-
-Run unit tests locally with `npm run test`.
-
-### Environments
-
-### Versioning and releasing
-
-- Merge required changes via PR into `main` branch
-  - Ensure the version number in `package.json` and `CHANGELOG.md` match, with a summary of the changes included in the changelog
-- Pull down merged `main` branch to your local repository
-- Create a tag with the version number from the latest commit on `main`
-  - If the latest version you're looking to push is version "1.2.3", you can do this on the command line with
-    - `git tag v1.2.3`
-    - `git push --tags`
-- [Github actions](https://github.com/nhsuk/nhsuk-prototype-kit/actions/workflows/release.yml) will spring to life and create a release which will be visible on the [releases tab](https://github.com/nhsuk/nhsuk-prototype-kit/releases) of the repository.
-- Finally, edit the description of the release to match the content entered into the changelog.
-- To deploy the changes to Live, the promotion to Live from the Preview environment must have the appropriate approval in Azure.
-
-### Code Analysis
-
-Code analysis results can be found in [SonarQube](https://sonar.nhswebsite.nhs.uk/dashboard?id=nhsuk-prototype-kit).
+## Security
 
-## Support
+As with all prototypes made with the NHS.UK prototype kit, this is for research and testing only. Do not use real participant data.
 
-The NHS.UK prototype kit is maintained by NHS England. [Email us](mailto:[email protected]), open a [Github issue](https://github.com/nhsuk/nhsuk-prototype-kit/issues/new) or get in touch on the [NHS digital service manual Slack workspace](https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLTk4NDQ3YzkwYzk1Njk5YjAxYTI5YTVkZmUxMGQ0ZjA3NjMyM2ZkNjBlMWMxODVjZjYzNzg1ZmU4MWY1NmE2YzE).
+If you publish your prototypes online, they must be protected by a username and password. This is to prevent members of the public finding prototypes and thinking they are real services.