Update README.md

README.md

@@ -12,13 +12,6 @@ short_description: 'Streamlit application that detects the English accent '
 license: mit
 ---
 
-# Welcome to Streamlit!
-
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
-
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).
-
 
 # 🎙️ English Accent Audio Detector
 
@@ -40,6 +33,50 @@ This app uses the Accent-ID model developed by Juan Pablo Zuluaga on the CommonA
 
 The model is implemented using the SpeechBrain toolkit, a powerful open-source speech processing framework built on PyTorch.
 
+### 🚀 How to Use
+* Run the app:
+
+* Choose Input Method:
+
+  * Upload a video file (.mp4, .mov, .avi, .mkv)
+
+  * Or paste a valid YouTube URL.
+
+* Click "Download Video" (for YouTube) or upload file directly.
+
+* Click "Extract Audio"
+  The app:
+
+    * Extracts and trims audio to 2 minutes
+
+    * Transcribes the content
+
+    * Checks for English language
+
+* Click "Analyze Accent"
+
+  Displays the detected accent and confidence score
+
+
+### 🧠 Supported English Accents
+* American
+* British
+* Australian
+* Indian
+* Canadian
+* Bermudian
+* Scottish
+* African
+* Irish
+* New Zealand
+* Welsh
+* Malaysian
+* Philippine
+* Singaporean
+* Hong Kong
+* South Atlantic
+
+
 
 ## ⚙️ Setup Instructions
 
@@ -92,47 +129,6 @@ Download from https://ffmpeg.org/download.html and add it to your system PATH.
 <pre lang="text"> English_Accent_Audio_Detector/ ├── app.py # Main Streamlit application ├── README.md # Project documentation with usage instructions ├── requirements.txt # Python dependencies ├── packages.txt # System-level packages (e.g., ffmpeg) ├── utils/ # Utility modules │ ├── __init__.py # Makes utils a package │ ├── accent_analysis.py # Logic for analyzing and classifying accents │ ├── audio_processing.py# Audio trimming and processing │ ├── session_utils.py # Session state utilities │ └── video_processing.py# YouTube/video handling ├── models/ # Model management ├── __init__.py # Makes models a package ├── custom_interface.py# HuggingFace interface for the model └── model_loader.py # Loads Wav2Vec2 and Whisper models </pre>
 
 
-### 🚀 How to Use
-* Run the app:
-
-* Choose Input Method:
-
-  * Upload a video file (.mp4, .mov, .avi, .mkv)
-
-  * Or paste a valid YouTube URL.
-
-* Click "Download Video" (for YouTube) or upload file directly.
-
-* Click "Extract Audio"
-  The app:
-
-    * Extracts and trims audio to 2 minutes
-
-    * Transcribes the content
-
-    * Checks for English language
-
-* Click "Analyze Accent"
-
-  Displays the detected accent and confidence score.
-
-### 🧠 Supported English Accents
-* American
-* British
-* Australian
-* Indian
-* Canadian
-* Bermudian
-* Scottish
-* African
-* Irish
-* New Zealand
-* Welsh
-* Malaysian
-* Philippine
-* Singaporean
-* Hong Kong
-* South Atlantic
 
 ### 🛠️ Troubleshooting
 FFmpeg Not Found: Ensure it’s installed and accessible from the terminal/command prompt.