updated Readme.md

README.md

@@ -11,4 +11,108 @@ license: mit
 short_description: An agent that extracts data lineage, pipeline dependencies
 ---
 
+# Lineage Graph Accelerator 🔥
+
+A Gradio-based agent that extracts, summarizes, and visualizes data lineage from multiple metadata sources (BigQuery, dbt, Airflow, APIs, and more). Designed as a small, extendable framework of sub-agents that parse metadata, infer relationships, and render clear graph visualizations for exploration and debugging.
+
+## Architecture
+
+This project is organized as a collection of lightweight sub-agents (workers): a metadata parser, a graph visualizer, and optional integration adapters (BigQuery, URL fetcher, dbt, Airflow). The UI (Gradio) orchestrates these components and displays results as Mermaid diagrams.
+
+### Visual Overview
+
+```mermaid
+flowchart TD
+  A[User/UI (Gradio)] --> B[Main Agent / Orchestrator]
+  B --> C[Metadata Parser Sub-Agent]
+  B --> D[Graph Visualizer Sub-Agent]
+  B --> E[Integration Adapters]
+  E --> E1[BigQuery Adapter]
+  E --> E2[URL / API Adapter]
+  E --> E3[dbt / Airflow Adapter]
+  C --> F[Lineage Model / Relations]
+  F --> D
+  D --> G[Mermaid / DOT Renderer]
+  G --> H[UI Visualization]
+  style B fill:#f9f,stroke:#333,stroke-width:1px
+  style C fill:#bbf,stroke:#333,stroke-width:1px
+  style D fill:#bfb,stroke:#333,stroke-width:1px
+  style E fill:#ffd,stroke:#333,stroke-width:1px
+```
+
+## Features
+
+- Multi-source metadata ingestion (Text, BigQuery, URLs/APIs)
+- AI-assisted metadata parsing and relationship extraction (pluggable agent backend)
+- Mermaid and DOT visualization support (Mermaid rendered in the UI)
+- Lightweight, modular code designed for easy extension and testing
+
+## Built with
+
+- Gradio (UI)
+- Mermaid for graph visualizations (client-side)
+- Langsmith's Agent Builder (used to design and orchestrate the agent/sub-agent structure)
+
+This project was prepared as a submission for the MCP 1st Birthday celebration. See the Hugging Face MCP-1st-Birthday activity for context: https://huggingface.co/organizations/MCP-1st-Birthday/activity/all
+
+## Quickstart (local)
+
+1. Create and activate the project's virtual environment (macOS / zsh):
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+2. Install dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+3. Run the app (will open Gradio on http://127.0.0.1:7860):
+
+```bash
+python app.py
+```
+
+4. Open the UI in your browser and try the sample inputs (Text/File Metadata, BigQuery, URL/API).
+
+## Running tests
+
+Unit tests are included under `tests/` to validate the mermaid wrapper and extractor stubs.
+
+Run them with the venv python:
+
+```bash
+source .venv/bin/activate
+python -m unittest tests.test_app -v
+```
+
+## Notes and next steps
+
+- The current extractors are stubs that return sample Mermaid graphs. Replace the TODOs in `app.py` to integrate with your chosen agent backend (Langsmith, OpenAI, Anthropic, etc.) or actual metadata connectors.
+- Consider moving app construction into a `create_app()` factory to make imports and testing cleaner (avoid side-effects at module import time).
+- To provide DOT/Graphviz rendering in-browser, consider adding viz.js or generating SVG server-side.
+
+## Contributing
+
+Contributions welcome — open a PR or issue with ideas, bug reports, or integration adapters (dbt, Snowflake, Airflow connectors).
+
+## License
+
+MIT
+---
+title: Lineage Graph Accelerator
+emoji: 🔥
+colorFrom: gray
+colorTo: gray
+sdk: gradio
+sdk_version: 5.49.1
+app_file: app.py
+pinned: false
+license: mit
+short_description: An agent that extracts data lineage, pipeline dependencies
+---
+
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference