Update README.md

README.md

@@ -1,10 +1,95 @@
 ---
-title: README
-emoji: 🐠
-colorFrom: purple
-colorTo: yellow
+title: ArtyLLaMA
+emoji: 🦙🎨
+colorFrom: indigo
+colorTo: pink
 sdk: static
 pinned: false
 ---
 
-Edit this `README.md` markdown file to author your organization card.
+# ArtyLLaMA: Empowering Creativity with Open Source AI 🦙🎨
+
+ArtyLLaMA is an innovative chat interface for Open Source Large Language Models, leveraging the power of LLaMA.cpp. It features dynamic content generation and display through an "Artifacts-like" system, making AI-assisted creativity more accessible and interactive.
+
+## Model Description
+
+ArtyLLaMA is not a model itself, but a framework that allows users to interact with various LLaMA-based models. It provides a user-friendly interface for generating creative content, code, and visualizations using state-of-the-art language models.
+
+### Key Features:
+
+- 🧠 **LLaMA Integration**: Seamless support for LLaMa.cpp via the llama-cpp-python package
+- 🎨 **Dynamic Artifact Generation**: Create and display content artifacts during chat interactions
+- 🖥️ **Real-time HTML Preview**: Instantly visualize HTML artifacts
+- 🔄 **Multi-Model Support**: Choose from multiple language models in the `/models` folder
+- 📱 **Responsive Design**: Mobile-friendly interface built with Tailwind CSS
+- 🌙 **Dark Mode**: Easy on the eyes with a default dark theme
+- 🚀 **Local Inference**: Run models locally for privacy and customization
+
+## Intended Use
+
+ArtyLLaMA is designed for developers, researchers, and creative professionals who want to:
+
+- Explore the capabilities of open-source language models
+- Generate creative content, including code, designs, and written text
+- Prototype AI-assisted applications and workflows
+- Learn about and experiment with local AI inference
+
+## Limitations
+
+- Requires local installation and setup
+- Performance depends on the user's hardware capabilities
+- Limited to models compatible with LLaMA.cpp
+- Does not include built-in content moderation (users should implement their own safeguards)
+
+## Ethical Considerations
+
+Users of ArtyLLaMA should be aware of:
+
+- Potential biases present in the underlying language models
+- The need for responsible use and content generation
+- Privacy implications of using AI-generated content
+
+## Technical Specifications
+
+- **Framework**: Python with Flask backend, HTML/CSS/JavaScript frontend
+- **Required Libraries**: llama-cpp-python, Flask, Tailwind CSS, Alpine.js
+- **Supported Model Formats**: GGUF (compatible with LLaMA.cpp)
+- **Hardware Requirements**: Varies based on the chosen model size (optimized for systems with GPU acceleration)
+
+## Getting Started
+
+1. Clone the repository: `git clone https://github.com/kroonen/ArtyLLaMA`
+2. Set up a Python environment: `conda create -n ArtyLLaMa python=3.11 && conda activate ArtyLLaMa`
+3. Install dependencies: `pip install -r requirements.txt`
+4. Place LLaMA models in the `/models` directory
+5. Configure `app.py` for your hardware
+6. Run the application: `python app.py`
+7. Access the interface at `http://localhost:5000`
+
+For more detailed instructions and documentation, visit our [GitHub repository](https://github.com/kroonen/ArtyLLaMA).
+
+## License
+
+ArtyLLaMA is distributed under the MIT License. See the [LICENSE](https://github.com/kroonen/ArtyLLaMA/blob/main/LICENSE) file for more information.
+
+## Citation
+
+If you use ArtyLLaMA in your research or projects, please cite it as follows:
+
+```bibtex
+@software{artyllama2024,
+  author = {Robin Kroonen},
+  title = {ArtyLLaMA: Empowering Creativity with Open Source AI},
+  year = {2024},
+  url = {https://github.com/kroonen/ArtyLLaMA}
+}
+```
+
+## Contact
+
+For questions, feedback, or collaborations, please reach out to:
+
+- GitHub: [https://github.com/kroonen/ArtyLLaMA](https://github.com/kroonen/ArtyLLaMA)
+- Email: [email protected]
+
+We welcome contributions and feedback from the community!