Updated README

Author: marc-temp

README.md

@@ -8,9 +8,11 @@ This is an intentionally very simple service for storing files as there is cross
 requirements with ETD. Work needs to be done to review and potentially consolidate the two 
 projects.
 
-## Configuration
+## Setting up the service
 
-Application configuration can be found in `application.yml`. Some of these properties 
+### Configuration
+
+Application configuration can be found in `src/main/resources/application.yml`. Some of these properties 
 can be overridden at deployment time using environment variables.  
 
 | Environment variable   | Default                                 | Description                                                                                                                                    |
@@ -27,6 +29,51 @@ can be overridden at deployment time using environment variables.
 | SHARPNESS_THRESHOLD    | 60                                      | Threshold, in %, an image's sharpness must meet to pass quality check                                                                          |
 | SPRING_PROFILES_ACTIVE | `development`                           | Only needs to be set to "development" when running in docker with [localstack](https://github.com/localstack) for a mock local AWS environment |
 
+### Installation
+
+This repository is private, you will need access to UKForeignOffice to access it.
+
+```bash
+git clone https://github.com/UKForeignOffice/document-upload.git
+
+cd document-upload
+```
+
+#### Local development
+
+In `Dockerfile`, change the image to `cimg/openjdk:17.0.11`.
+
+In `docker-compose.yml`, change the `clamav` service `image: clamav/clamav:1.4.3`.
+In `docker-compose.yml`, add to the `clamav` service `platform: linux/amd64`.
+
+```bash
+./gradlew clean build
+```
+
+## Using the service
+
+### Run
+
+```bash
+docker compose up --build
+```
+
+### Endpoints
+
+1. `GET` `/v1/files/{id}` - Get a file by id
+
+```bash
+curl http://localhost:9000/v1/files/4ec76a9f310e0ee531.jpg
+```
+
+2. `POST` `/v1/files` - Scans and stores the files for viruses
+
+```bash
+curl -X POST -F \
+"files=@/path/to/file/4ec76a9f310e0ee531.jpg" \
+http://localhost:9000/v1/files
+```
+
 ## AntiVirus
 
 Scanning inbound files for viruses is supported by integration with ClamAV. An example

docker-compose.yml

@@ -9,4 +9,3 @@ services:
     build: .
     ports:
       - 9000:9000
-