Skip to content

Commit

Permalink
doc: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
TBXark committed Aug 26, 2024
1 parent 12e38ab commit 9604775
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 22 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,14 @@ You can customize the system initialization information so that your debugged pe
## Features

- Serverless deployment
- Multi-platform deployment support (Cloudflare Workers, Vercel, Render[...](doc/en/PLATFORM.md))
- Multi-platform deployment support (Cloudflare Workers, Vercel, Docker[...](doc/en/PLATFORM.md))
- Adaptation to multiple AI service providers (OpenAI, Azure OpenAI, Cloudflare AI, Cohere, Anthropic, Mistral...)
- Custom commands (can achieve quick switching of models, switching of robot presets)
- Support for multiple Telegram bots
- Streaming output
- Multi-language support
- Text-to-image generation
- [Plugin System](plugins), customizable plugins.

## Documentation

Expand Down
3 changes: 2 additions & 1 deletion README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@ ChatGPT-Telegram-Workers
## 特性

- 无服务器部署
- 多平台部署支持(Cloudflare Workers, Vercel, Render[...](doc/cn/PLATFORM.md))
- 多平台部署支持(Cloudflare Workers, Vercel, Docker[...](doc/cn/PLATFORM.md))
- 适配多种AI服务商(OpenAI, Azure OpenAI, Cloudflare AI, Cohere, Anthropic, Mistral...)
- 自定义指令(可以实现快速切换模型,切换机器人预设)
- 支持多个Telegram机器人
- 流式输出
- 多语言支持
- 文字生成图片
- [插件系统](plugins),可以自定义插件

## 文档

Expand Down
6 changes: 0 additions & 6 deletions adapter/README.md

This file was deleted.

7 changes: 2 additions & 5 deletions doc/cn/PLATFORM.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@

详情看[Vercel](../../adapter/vercel/README.md)。免费,无需域名,无需服务器。需要配置本地开发环境部署,不能通过复制粘贴部署。无存储服务,需要自己配置数据库。可以使用[Redis Cloud](https://redis.com)的免费redis。可以连接github自动部署,但是需要了解vercel的配置。

### 3. [Render](https://render.com/)

详情看[Render](../../adapter/render)。免费,无需域名,无需服务器。需要有一定的开发能力。
### 3. Local

### 4. Local

详情看[Local](../../adapter/debug/README.md)。本地的部署方式,需要配置本地开发环境,需要有一定的开发能力。
详情看[Local](../../adapter/debug/README.md)。本地的部署方式,需要配置本地开发环境,需要有一定的开发能力。支持docker部署。
9 changes: 2 additions & 7 deletions doc/en/PLATFORM.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ The easiest way, the deployment method supported by this project by default, see

See details at [Vercel](../../adapter/vercel). It is free, does not require a domain name or server. Deployment requires configuring the local development environment and cannot be done by copying and pasting. There is no storage service, so you need to configure your own database. You can use the free Redis from [Redis Cloud](https://redis.com). It can connect to GitHub for automatic deployment, but you need to understand Vercel's configuration.

### 3. Local

### 3. [Render](https://render.com/)

See [Render](../../adapter/render) for details.. Free, no domain name, no server required. Some development skills are required.

### 4. Local

See [Local](../../adapter/debug) for details. For local deployment method, you need to configure local development environment.
See [Local](../../adapter/debug) for details. For local deployment method, you need to configure local development environment. Supports Docker deployment.
4 changes: 2 additions & 2 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ services:
ports:
- "8787:8787"
volumes:
- ./adapter/local/config.json:/app/config.json
- ./wrangler.toml:/app/config.toml
- ./adapter/local/config.json:/app/config.json:ro # change `./adapter/local/config.json` to your local path
- ./wrangler.toml:/app/config.toml:ro # change `./wrangler.toml` to your local path

0 comments on commit 9604775

Please sign in to comment.