Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iuiaoin committed Jun 6, 2023
1 parent 3d90c5a commit 1005faf
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,35 @@
> A wechat robot based on ChatGPT with no risk, very stable! 🚀
> English | [中文文档](README_ZH.md)
## 🌟 Features

- [x] **Extremely Stable:** Implement based on windows hook, no worry about risk of wechat account restriction
- [x] **Basic Conversation:** Smart reply for private chat and group chat, support multiple rounds of session context memory, support GPT-3, GPT-3.5, GPT-4 models
- [x] **Image Generation:** Support image generation, Dell-E only model for now
- [x] **Flexible Configuration:** Support prompt settings, proxy, command settings and etc.

## 🚀 Getting Start

### Environment

Support Windows system(probably support Linux in the future based on [sandbox](https://github.com/huan/docker-wechat)) and `Python` needs to be installed at the same time

> It is recommended that the Python version be between 3.8.X~3.10.X, version 3.8 is perfect
#### 1. Clone repo

```bash
git clone https://github.com/iuiaoin/wechat-gptbot && cd wechat-gptbot
```

#### 2. Install dependencies

```bash
pip install -r requirements.txt
```

### Configuration

`config.template.json` in the root directory contains the configs template, you need to copy the template to create the final effective `config.json`

Work in progress...

0 comments on commit 1005faf

Please sign in to comment.