Skip to content

Commit d12d5de

Browse files
author
root
committed
docs: remove hybrid auth section, add cost disclaimer
- Removed Hybrid Auth (MAX + API Key) section - not supported - Added prominent cost monitoring warning at top - Users must monitor their provider dashboards for actual costs
1 parent 0d120d5 commit d12d5de

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ Intelligent AI model routing that cuts costs by 50-80% while maintaining quality
66

77
> **Note:** Designed for standard API key users (`ANTHROPIC_API_KEY`, `OPENAI_API_KEY`). MAX subscription OAuth is not currently supported — MAX users should continue using their provider directly.
88
9+
> ⚠️ **Cost Monitoring Required**
10+
>
11+
> RelayPlane routes requests to LLM providers using your API keys. **This incurs real costs.**
12+
>
13+
> - Set up billing alerts with your providers (Anthropic, OpenAI, etc.)
14+
> - Monitor usage through your provider's dashboard
15+
> - Check `/stats` endpoint to track request volume
16+
> - Start with test requests to understand routing behavior
17+
>
18+
> RelayPlane provides cost *optimization*, not cost *elimination*. You are responsible for monitoring your actual spending.
19+
920
[![CI](https://github.com/RelayPlane/proxy/actions/workflows/ci.yml/badge.svg)](https://github.com/RelayPlane/proxy/actions/workflows/ci.yml)
1021
[![npm version](https://img.shields.io/npm/v/@relayplane/proxy)](https://www.npmjs.com/package/@relayplane/proxy)
1122
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -299,25 +310,6 @@ Use Opus for code review with fallback:
299310
}
300311
```
301312

302-
### Hybrid Auth (MAX + API Key)
303-
304-
If you have a MAX subscription, you can use MAX for Opus and API keys for cheaper models:
305-
306-
```json
307-
{
308-
"auth": {
309-
"anthropicMaxToken": "your-max-token-here",
310-
"useMaxForModels": ["opus"]
311-
}
312-
}
313-
```
314-
315-
This routes:
316-
- **Opus requests** → MAX token (already paid for)
317-
- **Haiku/Sonnet requests** → API key (pay per token)
318-
319-
Best of both worlds: unlimited Opus via MAX, cheap Haiku for simple tasks.
320-
321313
## Data Storage
322314

323315
All data stored locally at `~/.relayplane/data.db` (SQLite).

0 commit comments

Comments
 (0)