Skip to content

docs: 补充项目界面预览 #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SurviveM merged 1 commit into from
Feb 27, 2026
Merged

docs: 补充项目界面预览 #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center">
<p align="center">
Copy link

@coderabbitai coderabbitai bot Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

移除文件头隐藏 BOM 字符。

Line 1 前存在不可见 U+FEFF，可能引发部分 Markdown 工具链的解析/差异显示异常，建议删除。

建议修复 
-<p align="center">
+<p align="center">
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 1, The README.md file contains a leading invisible BOM
character U+FEFF at the start of the file which can break Markdown tooling;
remove the BOM by deleting the first invisible character (U+FEFF) so the file
begins with the visible '<p align="center">' text, and save the file without BOM
(ensure your editor or the commit uses UTF-8 without BOM).

<img src="web/public/logo.png" alt="maxx logo" width="128" height="128">
</p>

Expand All @@ -8,6 +8,12 @@ English | [简体中文](README_CN.md)

Multi-provider AI proxy with a built-in admin UI, routing, and usage tracking.

## Preview

<p align="center">
<img src="web/public/preview.png" alt="maxx dashboard preview" width="960">
</p>

## Features

- **Multi-Protocol Proxy**: Claude, OpenAI, Gemini, and Codex API formats
Expand Down
8 changes: 7 additions & 1 deletion README_CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center">
<p align="center">
Copy link

@coderabbitai coderabbitai bot Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

建议移除文件头隐藏 BOM 字符。

Line 1 存在不可见 U+FEFF，可能导致部分编辑器或 CI 文档检查出现异常差异。

建议修复 
-<p align="center">
+<p align="center">
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README_CN.md` at line 1, The file README_CN.md contains a hidden BOM (U+FEFF)
at the start of line 1 before the "<p align=\"center\">" tag; remove the leading
BOM so the first character of the file is the '<' of "<p align=\"center\">".
Ensure the file is saved without a UTF-8 BOM (e.g., re-save as UTF-8 without BOM
or strip U+FEFF) so editors and CI see no invisible character.

<img src="web/public/logo.png" alt="maxx logo" width="128" height="128">
</p>

Expand All @@ -8,6 +8,12 @@

多提供商 AI 代理服务，内置管理界面、路由和使用追踪功能。

## 预览

<p align="center">
<img src="web/public/preview.png" alt="maxx dashboard preview" width="960">
</p>

## 功能特性

- **多协议代理**：支持 Claude、OpenAI、Gemini 和 Codex API 格式
Expand Down
Binary file added web/public/preview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.