Task: Update README with purpose of this repo (#31)

Author: m-houston

README.md

@@ -1,10 +1,49 @@
 # NHS Notify Config
 
-## Setup
+This repository contains code and schemas for NHS Notify configuration management, event publishing, and onboarding automation.
 
-### Prerequisites
+## Purpose
 
-### Configuration
+- **Configuration Model:** Defines and manages client, campaign, quota, supplier, and routing configuration for NHS Notify.
+- **Event Schemas:** Publishes configuration changes as events to an event bus for consumption by other system components.
+- **Onboarding Automation:** Automates and streamlines the onboarding of new integrators, supporting self-serve and admin-driven workflows.
+
+## Design
+
+### Configuration Management
+
+A phased approach will be used to improve client configuration management:
+
+1. **Libraries & Validation:** Standardise configuration and naming, reduce manual errors, and improve auditability.
+2. **API Layer:** Centralise access to configuration data.
+3. **Web UI:** Enable operations/admin teams to manage configuration with validation and audit trails.
+
+Configuration entities include:
+
+- `client`, `campaign`, `client_feature`, `client_quota`, `client_subscription`
+- `mesh_mailbox`, `apim_application`, `govuknotify_account`
+- `supplier_quota`, `channel_supplier`, `queue`, `suppression_filter`, `additional_mesh_report_subscription`
+
+Configuration changes are validated, auditable, and published to environments via an event bus.
+
+### Event Publishing
+
+Configuration changes are published as events to a central event bus, enabling decoupled updates across bounded contexts (core, print supplier API, template/routing UI, user management, etc.).
+
+Event publishing strategies include:
+
+- CLI tools (tactical)
+- Scheduled audit tasks (tactical)
+- Admin/Web UI (strategic, single source of truth)
+
+### Onboarding Automation
+
+Quick Start onboarding will enable rapid, self-serve client setup in INT:
+
+- **Phase 1:** CLI/script automation using minimal data (client name, APIM ID, etc.)
+- **Phase 2:** Web UI for onboarding, protected by CIS2 auth, triggers config change events
+- **Phase 3:** Admin UI for incremental client config management and production promotion
+- **Phase 4:** Full self-serve onboarding via Web UI (admin approval for production)
 
 ## Usage
 
@@ -14,8 +53,6 @@ There are `make` tasks for you to configure to run your tests. Run
 `make test` to see how they work. You should be able to use the same
 entry points for local development as in your CI pipeline.
 
-## Design
-
 ## Contributing
 
 Describe or link templates on how to raise an issue, feature request

scripts/config/vale/styles/config/vocabularies/words/accept.txt

@@ -1,8 +1,10 @@
+auditability
+auditable
 [A-Z]+s
 Bitwarden
 bot
+[Cc]onfig
 Cognito
-Config
 Cyber
 Dependabot
 draw.io
@@ -17,7 +19,7 @@ idempotence
 Jira
 OAuth
 Octokit
-onboarding
+[Oo]nboarding
 Podman
 Python
 rawContent