better readme

README.md

@@ -1,7 +1,67 @@
-# National Digital Exchange
+# National Digital Exchange (NDX) Website
 
 [![CI](https://github.com/co-cddo/ndx/actions/workflows/ci.yaml/badge.svg)](https://github.com/co-cddo/ndx/actions/workflows/ci.yaml) [![CodeQL](https://github.com/co-cddo/ndx/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/co-cddo/ndx/actions/workflows/github-code-scanning/codeql) ![GitHub License](https://img.shields.io/github/license/co-cddo/ndx) ![GitHub deployments](https://img.shields.io/github/deployments/co-cddo/ndx/github-pages) ![GitHub language count](https://img.shields.io/github/languages/count/co-cddo/ndx) ![GitHub top language](https://img.shields.io/github/languages/top/co-cddo/ndx) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/co-cddo/ndx/badge)](https://scorecard.dev/viewer/?uri=github.com/co-cddo/ndx) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8980/badge)](https://www.bestpractices.dev/projects/9498)
 
-The project is currently in an alpha phase, contributions are very welcome.
+> ⚠️ The project is currently in an alpha phase, contributions are very welcome.
 
-## Pull requests are very welcome
+## Overview
+
+This repository contains the source code for the National Digital Exchange (NDX) website. The NDX website serves as an informational platform to describe the National Digital Exchange initiative, its goals, and provide updates to stakeholders and the public.
+
+## Technology Stack
+
+- Static Site Generator: [Eleventy (11ty)](https://www.11ty.dev/)
+- CSS Framework: [GOV.UK Frontend](https://frontend.design-system.service.gov.uk/)
+- Package Manager: Yarn
+
+## Local Development
+
+To run this website locally:
+
+1. Clone the repository
+2. Install dependencies:
+   ```
+   yarn install
+   ```
+3. Run the development server:
+   ```
+   yarn start
+   ```
+
+## Project Structure
+
+- `src/`: Source files for the website
+- `_site/`: Output directory for the built site (generated)
+- `.eleventy.js`: Eleventy configuration file
+- `package.json`: Project dependencies and scripts
+
+## Key Features
+
+- Discover section for news, events, and case studies
+- Catalog of cloud services
+- Access request system for cloud services
+- Cloud Maturity Model and Assessment Tool
+
+## Contributing
+
+We welcome contributions to improve the NDX website. Please read our [Contributing Guidelines](CODE_OF_CONDUCT.md) for more details.
+
+## Content Management
+
+Content is managed through Markdown files located in the `src/` directory. The site uses Eleventy's collections to organize and display content.
+
+## Deployment
+
+This website is automatically deployed to GitHub Pages when changes are merged to the main branch.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+For website-related inquiries, please contact [[email protected]](mailto:[email protected]).
+
+---
+
+For more information about the National Digital Exchange itself, please visit the [About NDX](/About/NDA/NDX.md) section of this website.