Update README.md

README.md

@@ -1,27 +1,84 @@
-# JusticeAI – Criminal Record Analyzer
-
-JusticeAI is an AI-powered legal assistant designed to analyze and summarize criminal case records. It extracts key information such as names, crimes, locations, and judgments, then provides legal insights including applicable laws and recommended punishments based on Nigerian criminal law.
-
-## What It Does
-
-- Accepts pasted or uploaded criminal case text
-- Automatically summarizes long legal reports
-- Extracts named entities such as people, dates, crimes, courts, and locations
-- Classifies crime type based on Nigerian law
-- Recommends appropriate punishment according to legal sections
-
-## Technologies Used
-
-- Python
-- Hugging Face Transformers (`transformers`, `pipeline`)
-- PyTorch
-- Gradio (UI interface)
-
-## Getting Started
-
-To run locally:
-
-1. Clone the repository or upload files to your Hugging Face Space.
-2. Install dependencies:
-   ```bash
-   pip install -r requirements.txt
+
+# JusticeAI – Criminal Record Analyzer
+
+JusticeAI is an AI-powered legal assistant that analyzes and summarizes criminal case records. It extracts key information such as names, crimes, locations, and judgments, then provides legal insights, including applicable laws and recommended punishments, based on Nigerian criminal law.
+
+## Features
+
+- Automatically summarizes long-form legal/criminal case text
+- Extracts key named entities (people, locations, crimes, dates, institutions)
+- Classifies crimes based on keywords and legal context
+- Recommends legal punishments based on Nigerian criminal law
+- User-friendly interface powered by Gradio
+
+## Technologies Used
+
+- Python 3
+- Hugging Face Transformers
+- PyTorch
+- Gradio (for the web interface)
+
+## Getting Started
+
+To run the app locally:
+
+1. Clone or download this repository.
+2. Make sure you have Python 3 installed.
+3. Install required dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+4. Run the application:
+
+```bash
+python main.py
+```
+
+5. The app will launch in your browser at:
+
+```
+http://127.0.0.1:7860
+```
+
+## Example Input
+
+```
+On April 10, 2022, Sarah Johnson was arrested for armed robbery and sentenced to life imprisonment by the High Court in Kaduna.
+```
+
+## Example Output
+
+- **Summary**: A brief summary of the case
+- **Extracted Entities**: Names, crimes, places, and dates identified from the input
+- **Legal Analysis**:
+  - Crime: Armed Robbery
+  - Applicable Law: Robbery and Firearms Act, Section 1
+  - Recommended Punishment: Death penalty or life imprisonment
+
+## Deployment (Hugging Face Spaces)
+
+To deploy this app:
+
+1. Create a new Space at [Hugging Face Spaces](https://huggingface.co/spaces)
+2. Select the **Gradio SDK**
+3. Upload:
+   - `main.py`
+   - `requirements.txt`
+   - `README.md` (optional)
+4. The app will build and launch automatically.
+
+You will receive a permanent URL like:
+
+```
+https://your-username.hf.space/justiceai-analyzer
+```
+
+## License
+
+This project is open-source and built for educational and civic innovation purposes. Contributions and adaptations are welcome with appropriate credit.
+
+---
+
+Built for the **RAIN Hackathon 2025** at the University of Ibadan.