Docs: enhance README with Quickstart, examples, weights roadmap

README.md

@@ -23,7 +23,13 @@ use these as starting points for training or inference in medical NLP tasks.
 - Classification config example (`examples/classification/`)
 - Generation config example (`examples/generation/`)
 
-## Usage (Python)
+## Install
+
+```bash
+pip install medvllm
+```
+
+## Quickstart (Python)
 
 ```python
 from medvllm.medical.config.models.medical_config import MedicalModelConfig
@@ -34,6 +40,39 @@ print(cfg.task_type)
 Or directly load a specific example folder if exported as a subfolder with
 its own config files.
 
+## Examples
+
+- NER: [`examples/ner/config.json`](./examples/ner/config.json) | [`examples/ner/config.yaml`](./examples/ner/config.yaml)
+- Classification: [`examples/classification/config.json`](./examples/classification/config.json) | [`examples/classification/config.yaml`](./examples/classification/config.yaml)
+- Generation: [`examples/generation/config.json`](./examples/generation/config.json) | [`examples/generation/config.yaml`](./examples/generation/config.yaml)
+
+Use these as starting points and customize fields like `task_type`, `classification_labels`, `medical_entity_types`, and domain settings.
+
+## Tasks supported
+
+- Named Entity Recognition (NER)
+- Text Classification
+- Text Generation
+
+All tasks share a unified configuration schema via `MedicalModelConfig`.
+
+## Weights roadmap
+
+This repo currently focuses on configs. Model weights/adapters will be added progressively:
+
+- BioBERT/ClinicalBERT adapters
+- Task-specific fine-tuned checkpoints (NER/Classification)
+
+Follow the repo for updates or open a Discussion to request specific checkpoints.
+
+## Debug and logging
+
+By default, verbose config debug prints are silenced. To enable them for troubleshooting, set:
+
+```bash
+export MEDVLLM_CONFIG_DEBUG=1
+```
+
 ## Medical Disclaimer
 
 This repository and associated configurations are provided for research and