Added Documentation for the validation of a pathology folder.

README.md

@@ -1 +1,39 @@
-[![codecov](https://codecov.io/gh/madgik/mipdb/branch/main/graph/badge.svg?token=BGF1OU23JA)](https://codecov.io/gh/madgik/mipdb)
+# mipdb [![codecov](https://codecov.io/gh/madgik/mipdb/branch/main/graph/badge.svg?token=BGF1OU23JA)](https://codecov.io/gh/madgik/mipdb)
+
+mipdb is a tool to validate datasets for the MIP platform.
+
+## Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+
+- **python**
+- **pip**
+
+## Installation
+
+You can easily install mipdb using `pip`:
+
+```bash
+pip install mipdb
+```
+
+## Usage
+
+### Validating a Pathology Folder
+
+**Command**: `mipdb validate-folder <folder_path>`
+
+**Description**:
+- The command enforces the following [requirements](https://github.com/HBPMedical/mip-deployment/blob/master/documentation/NewDataRequirements.md).
+- First, the metadata file itself is validated.
+- Secondly, the csvs in the folder are validated against the metadata.
+
+**Note**: You can nest multiple pathology folders within a parent folder, and the `validate-folder` command will automatically iterate through each pathology folder.
+
+**Examples**:
+```bash
+  mipdb validate-folder /home/user/data/dementia
+```
+```bash
+  mipdb validate-folder /home/user/data
+```