Skip to content

Commit 69b2bbf

Browse files
SantiagoDePoloniaSantiagoDePolonia
committed
doc: updated roadmap and quick start
1 parent e4ebd44 commit 69b2bbf

1 file changed

Lines changed: 53 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 53 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ GoModel is a high-performance, easy-to-use AI gateway written in Go.
44

55
## Quick Start
66

7+
### Manually
8+
9+
// TODO: add required changes. Make it concise
10+
711
1. Set environment variables (either via creating `.env` file based on `.env.template` or export):
812

9-
**Option A: Create a `.env` file:**
13+
**Option A: Create a `.env` file based on `.env.template`:**
1014

1115
```bash
1216
$ cp .env.template .env
@@ -15,28 +19,27 @@ GoModel is a high-performance, easy-to-use AI gateway written in Go.
1519
**Option B: Export environment variables:**
1620

1721
```bash
18-
export PORT=8080
1922
export OPENAI_API_KEY="your-openai-key"
2023
export ANTHROPIC_API_KEY="your-anthropic-key"
2124
export GEMINI_API_KEY="your-gemini-key"
2225
```
2326

24-
Note: At least one API key (OpenAI, Anthropic, or Gemini) is required.
27+
Note: At least one API key (OpenAI, Anthropic, Gemini, etc.) is required.
2528

2629
2. Run the server:
2730

2831
```bash
2932
make run
3033
```
3134

32-
3. Test it:
35+
3. (optionally) Test it:
3336

3437
**OpenAI:**
3538

3639
```bash
3740
curl http://localhost:8080/v1/chat/completions \
3841
-H "Content-Type: application/json" \
39-
-d '{"model": "gpt-4o-mini", "messages": [{"role": "user", "content": "Hello!"}]}'
42+
-d '{"model": "gpt-5-nano", "messages": [{"role": "user", "content": "Hello!"}]}'
4043
```
4144

4245
**Anthropic:**
@@ -55,6 +58,10 @@ GoModel is a high-performance, easy-to-use AI gateway written in Go.
5558
-d '{"model": "gemini-2.0-flash", "messages": [{"role": "user", "content": "Hello!"}]}'
5659
```
5760

61+
### Really quick start With docker
62+
63+
To be added...
64+
5865
## Development
5966

6067
### Testing
@@ -80,11 +87,21 @@ make lint # check the code quality
8087
make lint-fix # try to fix the code automatically
8188
```
8289

90+
### Pre-commit
91+
92+
You can install predefined pre-commit checks with [pre-commit CLI tool](https://pre-commit.com/). To do so, use the following commands or [follow the official pre-commit documentation](https://pre-commit.com/#install):
93+
94+
```bash
95+
pip install pre-commit
96+
pre-commit install
97+
```
98+
8399
## Running with Docker
84100

85101
You can use the official `golang:1.24-alpine` image to run the project in a container:
86102

87103
```bash
104+
make build
88105
docker run --rm -it \
89106
-v $(pwd):/app \
90107
-w /app \
@@ -98,13 +115,36 @@ docker run --rm -it \
98115

99116
Note: You can omit any API keys if you only want to use specific providers (at least one required).
100117

118+
# Roadmap
119+
101120
## Supported Providers
102121

103-
| Provider | Status |
104-
| ------------- | ------ |
105-
| OpenAI | ✅ |
106-
| Anthropic | ✅ |
107-
| Google Gemini | ✅ |
108-
| OpenRouter | 🔜 |
109-
| Groq | 🔜 |
110-
| xAI | 🔜 |
122+
| Provider | Basic support | Pass-through | Voice models | Image gen | Image gen | Full /responses API | Embedding | Caching |
123+
| ------------- | ------------- | ----------------- | ----------------- | ----------------- | ----------------- | ------------------- | ----------------- | ----------------- |
124+
| OpenAI | ✅ | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... |
125+
| Anthropic | ✅ | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... |
126+
| Google Gemini | ✅ | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... |
127+
| OpenRouter | ✅ | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... |
128+
| Groq | ✅ | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... |
129+
| xAI | ✅ | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... | 🚧 Coming soon... |
130+
131+
## Features
132+
133+
| Feature | Basic support | Full support |
134+
| -------------------------- | ----------------- | ----------------- |
135+
| Billing Management | 🚧 Coming soon... | 🚧 Coming soon... |
136+
| Full-observibility | 🚧 Coming soon... | 🚧 Coming soon... |
137+
| Budget management | 🚧 Coming soon... | 🚧 Coming soon... |
138+
| Many keys support | 🚧 Coming soon... | 🚧 Coming soon... |
139+
| Administrative endpoints | 🚧 Coming soon... | 🚧 Coming soon... |
140+
| Guardrails | 🚧 Coming soon... | 🚧 Coming soon... |
141+
| SSO | 🚧 Coming soon... | 🚧 Coming soon... |
142+
| System Prompt (GuardRails) | 🚧 Coming soon... | 🚧 Coming soon... |
143+
144+
## Integrations
145+
146+
| Integration | Basic integration | Full support |
147+
| ------------- | ----------------- | ----------------- |
148+
| Prometheus | ✅ | 🚧 Coming soon... |
149+
| DataDog | 🚧 Coming soon... | 🚧 Coming soon... |
150+
| OpenTelemetry | 🚧 Coming soon... | 🚧 Coming soon... |

0 commit comments

Comments
 (0)