Add README

Author: wildjames

README.md

@@ -1,5 +1,13 @@
 # eps-workflow-quality-checks
-A workflow to run the quality checks for EPS repositories
+A workflow to run the quality checks for EPS repositories. The steps executed by this script are as follows:
+
+- **Install Project Dependencies**
+- **Generate and Check SBOMs**: Creates Software Bill of Materials (SBOMs) to track dependencies for security and compliance. Uses [THIS](https://github.com/NHSDigital/eps-action-sbom) action.
+- **Run Linting**
+- **Run Unit Tests**
+- **SonarCloud Scan**: Performs code analysis using SonarCloud to detect quality issues and vulnerabilities.
+- **Validate CloudFormation Templates** (*Conditional*): If CloudFormation or AWS SAM templates are present, runs `cfn-lint` and `cfn-guard` to validate templates against AWS best practices and security rules.
+- **Check Python Licenses** (*Conditional*): If the project uses Poetry, scans Python dependencies for incompatible licenses.
 
 # Usage
 
@@ -14,13 +22,33 @@ One of `[18, 20, 22]`. SBOM generations requires knowing which version of nodeJS
 In order to run, these `make` commands must be present. They may be mocked, if they are not relevant to the project.
 
 - `install`
-- `check-licenses`
 - `lint`
 - `test`
-- `cfn-guard`
 
 ## Environment variables
 
 ### `SONAR_TOKEN`
 
-Required for the SonarCloud Scan step, which analyzes your code for quality and security issues using SonarCloud.
+Required for the SonarCloud Scan step, which analyzes your code for quality and security issues using SonarCloud.
+
+# Example Workflow Call
+
+To use this workflow in your repository, call it from another workflow file:
+
+```yaml
+name: Quality Checks
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+  quality_checks:
+    uses: NHSDigital/eps-workflow-quality-checks/.github/workflows/quality-checks.yml@v1
+    with:
+      node_version: '20'
+    secrets:
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+```