Update README.md

README.md

@@ -1,5 +1,5 @@
 ---
-title: BableSlide 1.0
+title: BabelSlide 1.0
 emoji: 🐠
 colorFrom: gray
 colorTo: green
@@ -8,7 +8,41 @@ sdk_version: 5.12.0
 app_file: app.py
 pinned: false
 license: apache-2.0
-short_description: PPT translator
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# BabelSlide 1.0
+
+**BabelSlide** is a tool for translating PowerPoint presentations using advanced AI language models such as DeepSeek, ChatGPT, and Mistral. The application allows you to translate slides into a target language and generates a review of the translation.
+
+## How to Use
+
+1. **Upload a PowerPoint File**: Click the "Upload PowerPoint File" button to select a `.pptx` file.
+2. **Choose an API Provider**: Select an API provider (e.g., DeepSeek, ChatGPT, Mistral) from the dropdown menu.
+3. **Enter Your API Key**: Input your API key in the "API Key" field.
+4. **Select Languages**: Choose the source and target languages from the dropdown menus.
+5. **Start Translation**: Click the "Translate" button to begin the translation process.
+6. **Download Results**: Once the translation is complete, download the translated PowerPoint file and the review file.
+
+## Requirements
+
+To run the application locally, you need:
+
+- Python 3.8 or newer
+- Installed libraries: `python-pptx`, `openai`, `gradio`
+
+You can install the required libraries using the following command:
+
+```bash
+pip install python-pptx openai gradio
+License
+This project is licensed under the Apache License 2.0.
+
+Authors:
+Heuristica
+Marek Staniszewski
+
+Support
+For any questions or support, please contact:
+Email: staniszewski@heuristica.pl
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference