Update README.md

README.md

@@ -11,4 +11,50 @@ short_description: Explains your json/yaml text/file/url
 
 ---
 
+# JSON & YAML Explainer
+An AI-powered explainer tool that converts JSON, YAML, and configuration files (OpenAPI specs, Terraform, Kubernetes manifests, CI/CD pipelines) into clear, natural language explanations.
+
+# Features
+Multi-format support: JSON, YAML, .yml, .json
+
+Developer Mode: Get technical breakdowns with field-level details
+
+ELI5 Mode: Simplified explanations for beginners and non-technical users
+
+Supports multiple domains:
+
+OpenAPI specifications
+
+Terraform configuration files
+
+Kubernetes manifests
+
+GitHub Actions & CI/CD pipelines
+
+# How It Works
+Upload your JSON/YAML file or paste raw text.
+
+Choose ELI5 or Developer Mode.
+
+The app uses a fine-tuned FLAN-T5 / Mistral model to generate clear, context-aware explanations.
+
+# Tech Stack
+Python
+
+FastAPI
+
+Gradio UI
+
+Hugging Face Transformers
+
+OpenRouter API for LLM inference
+
+# Installation
+
+pip install -r requirements.txt
+python app.py
+
+# Deployment
+Can be deployed on Hugging Face Spaces or as a standalone FastAPI service.
+
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference