Update README.md

README.md

@@ -1,2 +1,69 @@
-# CDLDownloader
+<h1 align="center">CDL Downloader</h1>
 
+<h3 align="center"><b>Automation script for downloading medical test results files from <a href="ewyniki.cdl.pl">ewyniki.cdl.pl</a></b></h3>
+
+<p align="center">CDL Downloader makes use of Selenium test software to automatically fill patient data textboxes and download PDF files.</p>
+
+---
+
+## Features
+
+- Headless mode - can be used entirely without graphical interface
+- Returns basic information after download - script returns basic data in JSON format, such as failure/success status and tests results as html table
+
+## Requirements
+
+- Chrome Driver installed
+- PIP packages:
+    - `selenium`
+    - `webdriver-manager`
+    - `argparse`
+
+You can also use `requirements.txt` file to install PIP dependencies
+
+```
+pip install -r cdl_downloader/requirements.txt
+```
+
+## Usage
+
+```
+python cdl_downloader <pesel> <barcode>
+```
+
+**Additional options:**
+
+- `--headless` - headless mode
+- `--path <path>` - set download path
+
+**Execution:**
+
+1. Script starts browser
+2. Goes to <a href="https://ewyniki.cdl.pl/kl322-n/index.php?page=logowanie&barcodeLogin=true">ewyniki.cdl.pl barcode login page</a>
+3. Fills PESEL and barcode textbox and submit
+4. Waits either for error message (and then stops and returns error) or download button
+5. Gathers info about test results
+6. Creates dedicated download directory
+7. Downloads file
+
+**Returned data:**
+
+In case of failure:
+
+```
+{
+    "success": false
+}
+```
+
+In case of success:
+
+```
+{
+    "success": true,
+    "id": "e1ce9235-9c36-4b7a-b245-e2f1c3d3b1c0",
+    "fileName": "/mnt/example/download_dir/e1ce9235-9c36-4b7a-b245-e2f1c3d3b1c0/TEST_FILE.pdf",
+    "formattedDate": "2026.01.31",
+    "resultTableHTML": "<table>...</table>"
+}
+```