Init README

README.md

@@ -0,0 +1,59 @@
+# Rubra: Open-Source ChatGPT for Developers
+
+Welcome! Rubra is built for those who want to engage with multiple LLMs (especially the local one we ship), develop and utilize custom assistants, and maintain data privacy through self-hosting.
+
+## Features
+
+- **Multi-Model Support:** Rubra integrates with a variety of LLMs, including a local model optimized for Rubra, as well as models from OpenAI and Anthropic. More providers will be added in the future.
+- **Development Tools:** Create powerful assistants using tools for web search, knowledge retrieval, and more, all designed to augment your LLMs with the information they need to be truly helpful.
+- **OpenAI API Compatibility:** Use OpenAI's Python and JavaScript libraries with Rubra's API for a seamless development experience.
+- **Self-Hosting:** Keep your data private and secure by running Rubra on your own hardware.
+
+## Getting Started
+
+### Prerequisites
+
+- M-series Mac or Linux with GPU
+- At least 16 GB RAM
+- At least 10 GB of available disk space
+- Docker and Docker Compose installed
+
+### Installation
+
+Rubra offers a simple one-command installation:
+
+```bash
+curl -sfL https://raw.githubusercontent.com/acorn-io/rubra/main/quickstart.sh | sh -s -- start
+```
+
+After installation, access the Rubra UI at `http://localhost:8501` and start exploring the capabilities of your new ChatGPT-like assistant.
+
+## Usage
+
+Here's a quick example of how to create an assistant using Rubra's API, compatible with OpenAI's libraries:
+
+```python
+from openai import OpenAI
+
+client = OpenAI(
+    base_url="http://localhost:8000",  # Rubra backend
+    api_key=""
+)
+
+assistant = client.beta.assistants.create(
+  instructions="You are a customer support chatbot. Use your knowledge base to best respond to customer queries.",
+  model="rubra_local",
+  tools=[{"type": "retrieval"}],
+  file_ids=[client.files.create(file=open("knowledge.txt", "rb"), purpose='assistants').id]
+)
+```
+
+## Contributing
+
+We welcome contributions from the developer community! Whether it's adding new features, fixing bugs, or improving documentation, your help is invaluable. Check out our [contributing guidelines](CONTRIBUTING.md) for more information on how to get involved.
+
+## Support
+
+If you encounter any issues or have questions, please file an issue on GitHub. For more detailed guidance and discussions, join our community on [Discord](https://discord.gg/swvAH2DXZH) or [Slack](https://slack.acorn.io) or start a [Github discussion](https://github.com/acorn-io/rubra/discussions).
+
+---