Update README.md

README.md

@@ -1,41 +1,71 @@
-# SocialAegis MVP
-
-**SocialAegis** is a sentiment-based escalation engine designed to detect emotional volatility in social media posts. It analyzes text inputs, assigns a risk score, and triggers escalation if needed, helping identify potentially harmful or urgent content in real time.
-
-## Features
-- **Sentiment Analysis:** Detects whether a post is positive, neutral, or negative.
-- **Risk Scoring:** Assigns a numerical risk score based on the emotional intensity of the text.
-- **Escalation Trigger:** Flags posts that may require moderation or immediate attention.
-- **Multilingual Support:** Works with multiple languages using `langdetect`.
-
-## How to Use
-1. Enter your text in the input box.
-2. The tool will return:
-   - **Sentiment:** Positive, Neutral, or Negative.
-   - **Risk Score:** A numerical value (0–10) representing emotional volatility.
-   - **Escalation Triggered:** Yes/No based on the risk score threshold.
-
-### Example Inputs
-- `"I am so frustrated with this service!"` → Negative sentiment, high risk.
-- `"I had an amazing experience, thank you!"` → Positive sentiment, low risk.
-- `"This is unacceptable, I will report this."` → Negative sentiment, moderate/high risk.
-
-## Dependencies
-The app uses the following Python libraries:
-- `gradio`
-- `transformers`
-- `torch`
-- `scipy`
-- `sentencepiece`
-- `protobuf`
-- `langdetect`
-
-## Notes
-- Designed to run on Hugging Face Spaces with automatic dependency installation.
-- Compatible with text inputs in multiple languages and different formats (plain text, emojis, etc.).
-- The risk scoring logic can be customized in `app.py`.
-
----
-
-**Author:** Karthik Vinay and Team  
-**Project:** SocialAegis  
+---
+license: mit
+title: Social Aegis
+sdk: gradio
+emoji: ⚡
+colorFrom: blue
+colorTo: yellow
+pinned: true
+---
+# SocialAegis MVP
+
+🛡️ A sentiment-based escalation engine to detect emotional volatility in social media posts.
+
+---
+
+## Overview
+
+SocialAegis is designed to analyze text from social media and other sources to detect sentiment, calculate a risk score, and determine whether escalation is needed. This helps organizations monitor emotional volatility in communications and take timely action.
+
+---
+
+## Features
+
+- **Sentiment Analysis** – Classifies input text as Positive, Neutral, or Negative.  
+- **Risk Scoring** – Provides a numerical score indicating the emotional intensity or risk level.  
+- **Escalation Trigger** – Indicates whether the text requires escalation based on the risk score.  
+- **Supports All Text Inputs** – Works with short posts, long messages, and multiple languages.  
+
+---
+
+## How to Use
+
+1. Enter your text into the input box.  
+2. Click **Submit** or **Run**.  
+3. The app will return:  
+   - **Sentiment** (Positive / Neutral / Negative)  
+   - **Risk Score** (rounded to 2 decimal places)  
+   - **Escalation Trigger** (Yes / No)  
+
+### Example Inputs
+
+- `"I am so frustrated with this service!"`  
+- `"I had an amazing experience, thank you!"`  
+- `"This is unacceptable, I will report this."`  
+
+---
+
+## Dependencies
+
+The app requires the following Python packages (all included in `requirements.txt`):
+
+- `gradio`
+- `transformers`
+- `torch`
+- `scipy`
+- `sentencepiece`
+- `protobuf`
+- `langdetect`
+
+---
+
+## Notes
+
+- The model runs entirely in Hugging Face Spaces. No additional setup is required if you use the provided `requirements.txt`.  
+- For best results, enter text in a single language at a time.  
+
+---
+
+## Credits
+
+Developed by Karthik Vinay for SocialAegis MVP.