Updated README

README.md

@@ -1,27 +1,73 @@
 # Daily Quote Generator
 
-The Daily Quote Generator is a Python script that fetches a random inspirational quote daily from a public API and commits it to this repository. It's designed to demonstrate automation, API usage, and version control integration.
+![Daily Quote](public/daily_quote.png)
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Python Version](https://img.shields.io/badge/Python-3.8%2B-blue.svg)](https://www.python.org/downloads/)
+[![Docker](https://img.shields.io/badge/Docker-Available-green.svg)](https://www.docker.com/)
+
+The **Daily Quote Generator** is a Python-based automation tool that fetches a random inspirational quote daily from a public API and commits it to this repository. This project showcases automation, API integration, sentiment analysis, and containerization using Docker.
+
+## Table of Contents
+
+- [Daily Quote Generator](#daily-quote-generator)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+  - [Screenshot](#screenshot)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Installation](#installation)
+    - [Usage](#usage)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## Features
+
+- **Automated Quote Fetching:** Retrieves a new inspirational quote daily from the [API Ninjas Quotes API](https://api-ninjas.com/api/quotes).
+- **Multi-language Support:** Translates quotes into Spanish and Portuguese using the [MyMemory Translation API](https://mymemory.translated.net/doc/spec.php).
+- **Sentiment Analysis:** Analyzes the sentiment of each quote using NLTK's VADER and visualizes the results with t-SNE.
+- **Version Control Integration:** Commits and pushes new quotes to the repository automatically.
+- **Dockerized Setup:** Easily build and run the application in a Docker container.
+- **Logging:** Comprehensive logging for monitoring and troubleshooting.
+
+## Screenshot
+
+![Daily Quote](public/daily_quote.png)
 
 ## Getting Started
 
+Follow these instructions to set up and run the Daily Quote Generator on your local machine.
+
 ### Prerequisites
 
-Ensure you have Python installed on your system. This project was built with Python 3.8, but it should be compatible with newer versions.
+- **Python:** Version 3.8 or higher. [Download Python](https://www.python.org/downloads/)
+- **Git:** For version control. [Download Git](https://git-scm.com/downloads)
+- **Docker:** (Optional) For containerization. [Download Docker](https://www.docker.com/get-started)
 
 ### Installation
 
-1. Clone this repository to your local machine:
-   ```
+1. **Clone the Repository:**
+
+   ```bash
    git clone https://github.com/hipnologo/daily_quote.git
    ```
-2. Navigate to the project directory:
+2. **Navigate to the project directory:**
    ```
    cd daily_quote
    ```
-3. Install the required dependencies:
+3. **Install Python Dependencies:**
+   It's recommended to use a virtual environment.
    ```
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   pip install --upgrade pip
    pip install -r requirements.txt
    ```
+4. Install NLTK Data:
+   The script uses NLTK's VADER for sentiment analysis.
+   ```
+   python -c "import nltk; nltk.download('vader_lexicon')"
+   ```
 
 ### Usage
 
@@ -40,4 +86,7 @@ We welcome contributions! Please see `CONTRIBUTING.md` for more details.
 
 This project is licensed under the MIT License - see the `LICENSE` file for details.
 
-<a href="https://www.buymeacoffee.com/hipnologod" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+<a href="https://www.buymeacoffee.com/hipnologod" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+
+
+<p align="center"> <a href="https://github.com/hipnologo/daily_quote/issues">Report Bug</a> • <a href="https://github.com/hipnologo/daily_quote/issues">Request Feature</a> </p> ```