Merge pull request #178 from ONSdigital/Update_readme

Update readme
ONSdigital · Nov 1, 2024 · c1f7f93 · c1f7f93
2 parents 7acde76 + a39a97c
commit c1f7f93
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 21 deletions.
diff --git a/features/README.md b/features/README.md
@@ -1 +1,3 @@
-TODO
+# `environment` setup
+
+This script sets up an environment for acceptance testing and removes it once testing has been completed.
diff --git a/myscript.py b/myscript.py
diff --git a/requirements.md b/requirements.md
@@ -4,7 +4,7 @@ This document outlines the [input requirements](#inputs) for files to be submitt
 
 ## Inputs
 
-The DTV pipeline is triggered when a single `.tar` file is uploaded to the designated AWS S3 bucket. This `.tar` file should contain the file(s) to be transformed, any supplementary distribution files, and a `manifest.json` file for configuring the pipeline.
+The DTV pipeline is triggered when one or more .tar files is uploaded to the designated AWS S3 bucket. Each .tar file should contain the file(s) to be transformed, any supplementary distribution files, and a manifest.json file for configuring the pipeline.
 
 Business areas wishing to submit datasets to the DTV pipeline will add the relevant files to an MS Sharepoint app/folder. The primary issue to be resolved is how the pipeline will be triggered when multiple files to be processed in one submission are added to Sharepoint.
 

diff --git a/tests/README.md b/tests/README.md
@@ -1 +1,7 @@
-# TODO
+# `tests` Directory
+
+This directory contains the `unit tests` and the required `test-cases`.
+
+`unit tests` are small tests to verify each function is working as intended.
+
+`test-cases` are test files that are used to run unit tests.