Update README.md

README.md

@@ -10,4 +10,162 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# All-in-One News Generator
+
+An AI-powered application that assists journalists and content creators in generating well-structured news articles by processing multiple types of input sources.
+
+Created by [Camilo Vega](https://www.linkedin.com/in/camilo-vega-169084b1/), AI Consultant
+
+![News Generator](https://via.placeholder.com/800x400?text=News+Generator+App)
+
+## Features
+
+- **Multi-Source Input Processing**:
+  - Audio and video transcription using OpenAI's Whisper model
+  - Social media content extraction (text and video)
+  - Document analysis (PDF, DOCX, XLSX, CSV)
+  - Web content extraction
+
+- **Advanced AI Article Generation**:
+  - Produces well-structured news articles following journalistic principles
+  - Automatically answers the 5 Ws (Who, What, When, Where, Why) in the first paragraph
+  - Maintains quote integrity with 80% direct quotes
+  - Customizable tone (serious, neutral, lighthearted)
+  - Adjustable article length
+
+- **User-Friendly Interface**:
+  - Organized tab-based input system
+  - Real-time transcription preview
+  - Simple one-click draft generation
+
+## Installation
+
+### Prerequisites
+
+- Python 3.8 or higher
+- [OpenAI API Key](https://platform.openai.com/)
+- Required packages (see requirements below)
+
+### Step 1: Clone the repository
+
+```bash
+git clone https://github.com/yourusername/news-generator.git
+cd news-generator
+```
+
+### Step 2: Create a virtual environment
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows, use: venv\Scripts\activate
+```
+
+### Step 3: Install dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+### Step 4: Set up your OpenAI API key
+
+```bash
+# On Linux/Mac
+export OPENAI_API_KEY="your-api-key-here"
+
+# On Windows
+set OPENAI_API_KEY="your-api-key-here"
+```
+
+### Requirements
+
+Create a `requirements.txt` file with the following dependencies:
+
+```
+openai
+whisper
+gradio
+pydub
+PyMuPDF
+python-docx
+pandas
+requests
+beautifulsoup4
+moviepy
+yt-dlp
+```
+
+## Usage
+
+### Starting the application
+
+```bash
+python app.py
+```
+
+The application will be available at `http://127.0.0.1:7860` in your web browser.
+
+### Using the application
+
+1. **Input your requirements**:
+   - Enter your news article instructions
+   - Describe the key facts of your news story
+   - Set the desired word count and tone
+
+2. **Add your sources**:
+   - Upload audio/video files for automatic transcription
+   - Add social media URLs to extract content
+   - Include web URLs for additional information
+   - Upload documents (PDF, DOCX, XLSX, CSV) to extract relevant data
+
+3. **Generate your draft**:
+   - Click "Generate Draft" to create your news article
+   - Review the transcriptions to verify source accuracy
+   - Use the generated draft as a starting point for your news story
+
+## Technical Details
+
+### Key Components
+
+- **Whisper Model**: Large-scale speech recognition model for accurate audio transcription
+- **yt-dlp**: Library for downloading videos from various platforms
+- **BeautifulSoup**: Web scraping tool for extracting content from URLs
+- **OpenAI API**: Powers the advanced language generation capabilities
+- **Gradio**: Creates the user-friendly web interface
+
+### Architecture
+
+The application follows a modular design with specialized functions for different types of content processing:
+
+- Audio/video processing pipeline:
+  1. Download or read file
+  2. Convert to audio if needed
+  3. Preprocess audio for quality
+  4. Transcribe using Whisper
+
+- Document processing:
+  - PDF: Extract text from all pages
+  - DOCX: Extract text from all paragraphs
+  - XLSX/CSV: Convert to string representation
+
+- Web content:
+  - Extract text from URLs
+  - Process social media content (both text and video)
+
+- Knowledge base compilation:
+  - Organize all sources into a structured format
+  - Prepare transcriptions with proper attribution
+  - Format content for AI processing
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgments
+
+- OpenAI for the Whisper and GPT models
+- Gradio team for the web interface framework
+- All open-source libraries utilized in this project
+
+---
+
+© 2025 Camilo Vega. All Rights Reserved.