[bugfix] minor fixes suggested by Adam

Author: marmoure

README.md

@@ -1,13 +1,13 @@
-# Broadband label file Validator Service
-This project provides a solution for validating Broadband Label files against defined Schemas. Developed by [Evolved Binary](https://www.evolvedbinary.com/) for use with the [FCC Broadband Labels](https://www.fcc.gov/broadbandlabels) initiative, the system consists of a HTTP REST API and a user-friendly Web Application.
+# Broadband Label file Validator Service
+This project provides a solution for validating Broadband Label files against defined Schemas. Developed for [Comcast](https://www.comcast.com) by [Evolved Binary](https://www.evolvedbinary.com) for use with the [FCC Broadband Labels](https://www.fcc.gov/broadbandlabels) initiative, the system consists of a HTTP REST API and a user-friendly Web Application.
 
-The core validation logic is built upon the Open Source [CSV Validator](https://github.com/digital-preservation/csv-validator) library, originally developed for The National Archives.
+The core validation logic is built upon the Open Source [CSV Validator](https://github.com/digital-preservation/csv-validator) library, originally developed for [The National Archives](https://www.nationalarchives.gov.uk/).
 
 ## Features
 
 * **HTTP REST API**: A robust API that exposes validation services to the internet.
 * **Web Application**: A simple HTML5 interface allowing users to upload files or provide URLs for validation.
-* **Multiple Input Methods**: Support for validating broadband label files via direct file upload or external URL retrieval.
+* **Multiple Input Methods**: Support for validating Broadband Label files via direct file upload or external URL retrieval.
 * **Schema Management**: dynamically lists and utilizes validation schemas stored in the configured directory.
 
 ## Endpoints
@@ -16,40 +16,90 @@ Check the API documentation for more information https://app.swaggerhub.com/apis
 ## Built With
 
 * [Java 21](https://openjdk.org/projects/jdk/21/) - Programming Language
-* [Micronaut 4](https://micronaut.io/) - The JVM-based framework used
-* [Apache Velocity](https://velocity.apache.org/) - Template engine for the Web Views
-* [Maven](https://maven.apache.org/) - Dependency Management
+* [Micronaut 4](https://micronaut.io/) - A Web Application framework
+* [Apache Velocity](https://velocity.apache.org/) - Provides templating for the Web Pages
+* [Maven](https://maven.apache.org/) - Build System
 * [Docker](https://www.docker.com/) - Containerization
 
+
+# Getting Started
+
 ## Prerequisites
 * Java 21
 * Maven 3.6+
 
-## Getting Started
-Using Maven
+## Running the Application
+
+### Option 1: Running in Development Mode
+
+Clone the repository and run the application directly using Maven:
 
 ```bash
 git clone https://github.com/evolvedbinary/bbl-validator.git
 cd bbl-validator
 mvn mn:run
 ```
 
-Build the JAR
+The application will start on http://localhost:8080.
+
+### Option 2: Building and Running the JAR
+
+#### Building the JAR
+
+Build an executable JAR file with all dependencies included:
 
 ```bash
+git clone https://github.com/evolvedbinary/bbl-validator.git
+cd bbl-validator
 mvn clean package
 ```
 
-Using Docker
+This will create an executable JAR file at `target/bbl-validator-1.0.0-SNAPSHOT.jar`.
+
+#### Running the JAR
+
+Once built, you can run the application using:
+
+```bash
+# Change the server port
+java -Dmicronaut.server.port=9090 -jar target/bbl-validator-1.0.0-SNAPSHOT.jar
+
+# Specify a schema directory
+java -Dschema.directory=/path/to/schema -jar target/bbl-validator-1.0.0-SNAPSHOT.jar
+```
+
+### Option 3: Using Docker
+
+#### Pulling and Running a Pre-built Image
+
+Pull the latest image from Docker Hub and run it:
+
+```bash
+docker pull evolvedbinary/bbl-validator:1.0.0-SNAPSHOT
+docker run -p 8080:8080 -v /path/to/schemas:/app/schemas:ro evolvedbinary/bbl-validator:1.0.0-SNAPSHOT
+```
+
+**Note:** Replace `/path/to/schemas` with the absolute path to your schemas directory on the host machine.
+
+#### Building the Docker Image (Optional)
+
+If you want to build the Docker image locally:
 
 ```bash
 git clone https://github.com/evolvedbinary/bbl-validator.git
 cd bbl-validator
 mvn clean install
-docker run -p 8080:8080 -v /path/to/schemas:/app/schemas:ro evolvedbinary/bbl-validator:1.0.0-SNAPSHOT
 ```
 
-note: use the absolute path to the schemas directory when running the docker container.
+This will:
+1. Build the application JAR
+2. Create a Docker image tagged as `evolvedbinary/bbl-validator:1.0.0-SNAPSHOT`
+
+Then run the locally built image:
+
+```bash
+docker run -p 8080:8080 -v /path/to/schemas:/app/schemas:ro evolvedbinary/bbl-validator:1.0.0-SNAPSHOT
+```
 
 ## Usage
 
@@ -78,8 +128,6 @@ The application uses application.yml for configuration.
 ## Contact and Support
 Evolved Binary Limited 
 
-Email: admin@evolvedbinary.com.
-
-Web: https://www.evolvedbinary.com.
+Email: tech@evolvedbinary.com
 
-Phone: +44 (0)2032 397236 / +1 917 267-8787.
+Web: https://www.evolvedbinary.com