diff --git a/README.md b/README.md index 63e779a4..ecbdeaf0 100644 --- a/README.md +++ b/README.md @@ -37,5 +37,37 @@ For a guide on how to develop your own version of Void, see [HOW_TO_CONTRIBUTE]( +## Orcest AI / RainyModel Configuration + +Orcide connects to the [RainyModel](https://rm.orcest.ai) LLM proxy for unified model routing across free, internal, and premium backends. + +### Setup + +1. Open Orcide Settings (gear icon in sidebar) +2. Select **OpenAI-Compatible** as the provider +3. Configure: + - **baseURL**: `https://rm.orcest.ai/v1` + - **API Key**: Your RainyModel API key +4. Add models and assign to features: + +| Feature | Recommended Model | +|---------|------------------| +| Chat | `rainymodel/chat` | +| Quick Edit (Ctrl+K) | `rainymodel/code` | +| Autocomplete | `rainymodel/code` | +| Apply | `rainymodel/auto` | + +### Available Models + +- `rainymodel/auto` - General purpose, cost-optimized routing +- `rainymodel/chat` - Conversation and Persian language +- `rainymodel/code` - Code generation and completion +- `rainymodel/agent` - Complex agent tasks (long context) + +### Routing + +RainyModel routes requests: FREE (HF/ollamafreeapi) -> INTERNAL (Ollama) -> PREMIUM (OpenRouter). +Use the `X-RainyModel-Policy` header for custom routing (auto, uncensored, premium, free). + ## Support You can always reach us in our Discord server or contact us via email: hello@voideditor.com.