From 6432efeb3507db5518cad16c7899e4f853a2b8e9 Mon Sep 17 00:00:00 2001 From: ChenZhoYu <790348264@qq.com> Date: Mon, 11 Mar 2024 12:00:53 +0800 Subject: [PATCH] chore: doc --- README.md | 65 ++++++++++++++++++++++++++++------------------------ README.zh.md | 5 ++++ 2 files changed, 40 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index ac5999f8a9..ba57c60f7f 100644 --- a/README.md +++ b/README.md @@ -8,35 +8,36 @@ ![cover2](./docs/c2.png) - [ChatGPT Web](#chatgpt-web) - - [Introduction](#introduction) - - [To-Do List](#to-do-list) - - [Prerequisites](#prerequisites) - - [Node](#node) - - [PNPM](#pnpm) - - [Fill in Keys](#fill-in-keys) - - [Install Dependencies](#install-dependencies) - - [Backend](#backend) - - [Frontend](#frontend) - - [Run in Test Environment](#run-in-test-environment) - - [Backend Service](#backend-service) - - [Frontend Webpage](#frontend-webpage) - - [Environment Variables](#environment-variables) - - [Packaging](#packaging) - - [Use Docker](#use-docker) - - [Docker Parameter Examples](#docker-parameter-examples) - - [Docker Build & Run](#docker-build--run) - - [Docker Compose](#docker-compose) - - [Prevent Crawlers](#prevent-crawlers) - - [Deploy with Railway](#deploy-with-railway) - - [Railway Environment Variables](#railway-environment-variables) - - [Deploy with Sealos](#deploy-with-sealos) - - [Package Manually](#package-manually) - - [Backend Service](#backend-service-1) - - [Frontend Webpage](#frontend-webpage-1) - - [FAQ](#faq) - - [Contributing](#contributing) - - [Sponsors](#sponsors) - - [License](#license) + - [Introduction](#introduction) + - [Roadmap](#roadmap) + - [Prerequisites](#prerequisites) + - [Node](#node) + - [PNPM](#pnpm) + - [Filling in the Key](#filling-in-the-key) + - [Install Dependencies](#install-dependencies) + - [Backend](#backend) + - [Frontend](#frontend) + - [Run in Test Environment](#run-in-test-environment) + - [Backend Service](#backend-service) + - [Frontend Webpage](#frontend-webpage) + - [Environment Variables](#environment-variables) + - [Packaging](#packaging) + - [Use Docker](#use-docker) + - [Docker Parameter Examples](#docker-parameter-examples) + - [Docker build \& Run](#docker-build--run) + - [Docker compose](#docker-compose) + - [Prevent Crawlers](#prevent-crawlers) + - [Deploy with Railway](#deploy-with-railway) + - [Railway Environment Variables](#railway-environment-variables) + - [Deploy with Sealos](#deploy-with-sealos) + - [Package Manually](#package-manually) + - [Backend Service](#backend-service-1) + - [Frontend Webpage](#frontend-webpage-1) + - [FAQ](#faq) + - [Contributing](#contributing) + - [Acknowledgements](#acknowledgements) + - [Sponsors](#sponsors) + - [License](#license) ## Introduction Supports dual models and provides two unofficial `ChatGPT API` methods @@ -340,6 +341,10 @@ Thanks to everyone who has contributed! +## Acknowledgements + +Thanks to [JetBrains](https://www.jetbrains.com/) SoftWare for providing free Open Source license for this project. + ## Sponsors If you find this project helpful and can afford it, you can give me a little support. Anyway, thanks for your support~ @@ -356,4 +361,4 @@ If you find this project helpful and can afford it, you can give me a little sup ## License -MIT © [ChenZhaoYu] \ No newline at end of file +MIT © [ChenZhaoYu] diff --git a/README.zh.md b/README.zh.md index 6b68be4d69..8cd88da106 100644 --- a/README.zh.md +++ b/README.zh.md @@ -35,6 +35,7 @@ - [前端网页](#前端网页-1) - [常见问题](#常见问题) - [参与贡献](#参与贡献) + - [致谢](#致谢) - [赞助](#赞助) - [License](#license) ## 介绍 @@ -343,6 +344,10 @@ A: 一种可能原因是经过 Nginx 反向代理,开启了 buffer,则 Nginx +## 致谢 + +感谢 [JetBrains](https://www.jetbrains.com/) 为这个项目提供免费开源许可的软件。 + ## 赞助 如果你觉得这个项目对你有帮助,并且情况允许的话,可以给我一点点支持,总之非常感谢支持~