Update README.md

README.md

@@ -11,99 +11,59 @@ license: mit
 short_description: The project involves developing a terminal-based user interf
 ---
 
-# RetroHackerTerminalUI 💻  
+# RetroHackerTerminalUI 💻
 
-RetroHackerTerminalUI is a terminal-based user interface designed for a retro, hacker-themed experience. Built using **Gradio**, it features a blend of modern functionality with a nostalgic terminal aesthetic, offering a fun and efficient way to interact with AI-driven tools or applications.  
+RetroHackerTerminalUI is a terminal-based user interface designed for a retro, hacker-themed experience. Built using Gradio, it features a blend of modern functionality with a nostalgic terminal aesthetic, offering a fun and efficient way to interact with AI-driven tools or applications.
 
-## 🎨 Project Highlights  
-- **Retro Aesthetic:** Experience a hacker-style terminal UI inspired by vintage green and purple terminal themes.  
-- **Powered by Gradio:** Leverages the Gradio SDK for rapid prototyping and deployment of user interfaces, ensuring a smooth and interactive experience.  
-- **Customizability:** Allows for modifications in both appearance and functionality to suit individual use cases.  
-- **AI-Driven Backend:** Integrates seamlessly with machine learning models or APIs to enhance functionality and usability.  
+### Project Highlights
+- **Retro Aesthetic**: Experience a hacker-style terminal UI inspired by vintage green and purple terminal themes.
+- **Powered by Gradio**: Leverages the Gradio SDK for rapid prototyping and deployment of user interfaces, ensuring a smooth and interactive experience.
+- **Customizability**: Allows for modifications in both appearance and functionality to suit individual use cases.
+- **AI-Driven Backend**: Integrates seamlessly with machine learning models or APIs to enhance functionality and usability.
 
----
-
-## 🚀 Features  
-1. **Dynamic Terminal Interface:**  
-   - Mimics the look and feel of retro command-line interfaces.  
-   - Includes animations, dynamic prompts, and command feedback.  
-
-2. **Interactive Components:**  
-   - Supports AI-driven tasks like text generation, debugging, data analysis, and more.  
-   - Allows users to input commands and get real-time feedback.  
-
-3. **Gradio Integration:**  
-   - Simple and efficient web-based deployment.  
-   - Supports both local and cloud hosting using Hugging Face Spaces.  
-
-4. **Custom Themes:**  
-   - Adjustable color schemes (default: green and purple) for personalized aesthetics.  
+### Features
+- **Dynamic Terminal Interface**: Mimics the look and feel of retro command-line interfaces, including animations, dynamic prompts, and command feedback.
+- **Interactive Components**: Supports AI-driven tasks like text generation, debugging, data analysis, and more.
+- **Gradio Integration**: Simple and efficient web-based deployment with both local and cloud hosting options on Hugging Face Spaces.
+- **Custom Themes**: Adjustable color schemes (default: green and purple) for personalized aesthetics.
+- **Ease of Use**: Designed to be intuitive even for non-technical users, with detailed prompts and tooltips.
 
-5. **Ease of Use:**  
-   - Designed to be intuitive even for non-technical users.  
-   - Includes detailed prompts and tooltips.  
+### How to Get Started with the Model
+To use the project, clone the repository and install dependencies:
 
----
-
-## 🛠️ Installation & Usage  
+```bash
+git clone https://huggingface.co/spaces/RetroHackerTerminalUI  
+cd RetroHackerTerminalUI  
+pip install -r requirements.txt  
+python app.py
+```
 
-### Requirements  
-- Python 3.8 or higher  
-- Gradio SDK version 5.9.1 or higher  
-- Hugging Face account (for deployment on Spaces)  
+Then navigate to `http://127.0.0.1:7860` to see the app in action.
 
-### Installation  
-1. Clone this repository:  
-   ```bash  
-   git clone https://huggingface.co/spaces/RetroHackerTerminalUI  
-   cd RetroHackerTerminalUI  
-   ```  
+### Deployment on Hugging Face Spaces
+1. Push your changes to Hugging Face:
 
-2. Install dependencies:  
-   ```bash  
-   pip install -r requirements.txt  
-   ```  
+```bash
+git add .  
+git commit -m "Initial commit"  
+git push
+```
 
-3. Run the app locally:  
-   ```bash  
-   python app.py  
-   ```  
+2. After pushing, the app will automatically build and deploy on Hugging Face Spaces.
 
-4. Open your browser and navigate to `http://127.0.0.1:7860` to view the app.  
+### Datasets
+- `Canstralian/ShellCommands`: Contains a dataset for shell command generation.
+- `Canstralian/CyberExploitDB`: Provides data for analyzing cybersecurity exploits.
 
----
+### Available Models
+- `Canstralian/text2shellcommands`: For generating shell commands.
+- `Canstralian/RabbitRedux`: A model for processing terminal-based interactions.
+- `Canstralian/CySec_Known_Exploit_Analyzer`: For analyzing cybersecurity exploits.
 
-## 🌐 Deployment on Hugging Face Spaces  
-RetroHackerTerminalUI can be deployed directly to Hugging Face Spaces. Follow these steps:  
-1. Push the repository to Hugging Face:  
-   ```bash  
-   git add .  
-   git commit -m "Initial commit"  
-   git push  
-   ```  
+### License
+This project is licensed under the MIT License. See the LICENSE file for more details.
 
-2. Configure the `README.md` and `app.py` files to align with your needs.  
-3. The app will be automatically built and hosted on Hugging Face Spaces.  
-
----
-
-## 📚 Documentation  
-For more details, check out the [Gradio Documentation](https://gradio.app) and the [Hugging Face Spaces Configuration Reference](https://huggingface.co/docs/hub/spaces-config-reference).  
-
----
-
-## 📝 License  
-This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.  
-
----
-
-## 📬 Contributing  
-Contributions are welcome! If you’d like to improve this project:  
-1. Fork the repository.  
-2. Create a new branch for your feature or bug fix.  
-3. Submit a pull request with a detailed description of your changes.  
-
----
+### Contributing
+Contributions are welcome! Fork the repository, create a new branch for your feature or bug fix, and submit a pull request with a detailed description of your changes.
 
-## 📢 Contact  
-For questions, feedback, or feature requests, please reach out via [Hugging Face Discussions](https://huggingface.co/spaces/RetroHackerTerminalUI/discussions).  
+For more questions or feature requests, reach out via Hugging Face Discussions.