docs: Add mermaid doc

Author: edmundmiller

README.md

@@ -2,6 +2,24 @@
 
 A Nextflow plugin for integrating [NVIDIA NIMs (NVIDIA Inference Microservices)](https://developer.nvidia.com/nim) as custom executors for bioinformatics workflows.
 
+```mmd
+graph TB
+    A[NIM Service<br/>Docker: localhost:8080 | Cloud: health.api.nvidia.com]
+    B[Nextflow Process<br/>task.ext.nim = rfdiffusion]
+    C[RFDiffusion Processing<br/>15 diffusion steps on protein structure]
+    D[Output Generation<br/>designed.pdb written to workflow]
+
+    A -.->|NVCF_RUN_KEY auth| B
+    B -->|POST /v1/biology/ipd/rfdiffusion/generate<br/>PDB + contigs A20-60/0 50-100| C
+    C -->|Structure optimization| C
+    C -->|JSON: status + results| D
+
+    style A fill:#76b900,color:#fff
+    style B fill:#667eea,color:#fff
+    style C fill:#2196F3,color:#fff
+    style D fill:#4CAF50,color:#fff
+```
+
 ## Overview
 
 This plugin provides a generic `nim` executor that can run NVIDIA NIM services for biological computing, specifically:
@@ -33,18 +51,21 @@ plugins {
 The plugin supports multiple authentication methods with flexible configuration options:
 
 **Method 1: Environment Variable (Traditional)**
+
 ```bash
 export NVCF_RUN_KEY="your-nvidia-api-key-here"
 ```
 
 **Method 2: Global Configuration**
+
 ```groovy
 nim {
     apiKey = 'your-api-key-here'
 }
 ```
 
 **Method 3: Service-Specific Configuration**
+
 ```groovy
 nim {
     rfdiffusion {
@@ -83,16 +104,16 @@ Use the `nim` executor in your processes and specify which NIM service to use wi
 ```groovy
 process myNIMProcess {
     executor 'nim'
-    
+
     input:
     // your inputs
-    
+
     output:
     // your outputs
-    
+
     script:
     task.ext.nim = "rfdiffusion"
-    
+
     """
     # Your script here - the NIM executor handles the actual API calls
     echo "Running ${task.ext.nim} analysis"
@@ -105,16 +126,16 @@ process myNIMProcess {
 ```groovy
 process rfdiffusionDesign {
     executor 'nim'
-    
+
     input:
     path pdb_file
-    
+
     output:
     path "output.pdb"
 
     script:
     task.ext.nim = "rfdiffusion"
-    
+
     """
     echo "Designing protein structure using RFDiffusion"
     """
@@ -125,7 +146,7 @@ Parameters for RFDiffusion can be set in `params`:
 
 ```groovy
 params.contigs = "A20-60/0 50-100"
-params.hotspot_res = ["A50","A51","A52","A53","A54"] 
+params.hotspot_res = ["A50","A51","A52","A53","A54"]
 params.diffusion_steps = 15
 ```
 
@@ -145,10 +166,10 @@ workflow {
 
 process designProtein {
     executor 'nim'
-    
+
     input:
     path pdb_file
-    
+
     output:
     path "designed.pdb"
 
@@ -163,10 +184,11 @@ process designProtein {
 ## Input Requirements
 
 ### RFDiffusion
+
 - **Input**: PDB file containing protein structure
-- **Parameters**: 
+- **Parameters**:
   - `params.contigs` - Contigs specification (default: "A20-60/0 50-100")
-  - `params.hotspot_res` - Hotspot residues (default: ["A50","A51","A52","A53","A54"])  
+  - `params.hotspot_res` - Hotspot residues (default: ["A50","A51","A52","A53","A54"])
   - `params.diffusion_steps` - Number of diffusion steps (default: 15)
 
 ## Health Checks
@@ -240,6 +262,7 @@ The test suite follows a 3-step integration testing pattern:
 3. **Verify API completion** - Check response and result files
 
 This separation allows for:
+
 - **Unit testing** - Mock components independently
 - **Integration testing** - Test with real API endpoints
 - **Isolated testing** - Test individual components without external dependencies
@@ -301,7 +324,7 @@ This project is licensed under the Apache License 2.0 - see the [COPYING](COPYIN
 For detailed information, see the comprehensive documentation in the [`docs/`](docs/) directory:
 
 - **[Installation Guide](docs/installation.md)** - Setup and installation instructions
-- **[Configuration Guide](docs/configuration.md)** - Configuration options and examples  
+- **[Configuration Guide](docs/configuration.md)** - Configuration options and examples
 - **[Authentication Guide](docs/authentication.md)** - Authentication methods and security
 - **[Usage Guide](docs/usage.md)** - Usage patterns and best practices
 - **[Examples Guide](docs/examples.md)** - Comprehensive workflow examples
@@ -310,4 +333,4 @@ For detailed information, see the comprehensive documentation in the [`docs/`](d
 
 ## Contributing
 
-Contributions are welcome! Please see the development guidelines in the source code for more information.
+Contributions are welcome! Please see the development guidelines in the source code for more information.