Skip to content

Commit

Permalink
update reamde
Browse files Browse the repository at this point in the history
  • Loading branch information
RexWzh committed May 14, 2024
1 parent 857e9f1 commit c23b443
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
14 changes: 13 additions & 1 deletion README-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,16 @@
[English](README-en.md) | [简体中文](README.md)
</div>

Interact with ChatGPT at the terminal, invoking ChatGPT anytime and anywhere.
AskChat is a command-line tool for ChatGPT interaction, allowing you to call ChatGPT anytime, anywhere.

Run in the terminal:

![hello](docs/assets/svgs/hello.svg)

Run in Jupyter Notebook:

![jupyter](docs/assets/jupyter.gif)

## Installation and Configuration

```bash
Expand Down Expand Up @@ -59,15 +65,19 @@ In addition, you can use `askchat` for more flexible dialogue and `askenv` to ma
### Usage Examples

1. API debugging, testing default parameters and return results.

![debug](docs/assets/svgs/debug.svg)

2. Get a list of available models.

![validmodels](docs/assets/svgs/validmodels.svg)

3. Multi-turn dialogue, saving dialogues, loading dialogues, etc.

![chatlog](docs/assets/svgs/chatlog.svg)

4. Specify parameters, using different models and APIs.

![para-models](docs/assets/svgs/para-models.svg)

### Dialogue Management
Expand Down Expand Up @@ -125,9 +135,11 @@ Note: `--all-valid-models` will print all available models, including Embedding,
### Examples

1. Create, view, activate, and delete channels.

![askenv](docs/assets/svgs/askenv.svg)

2. Edit channel.

![askenv-config](docs/assets/svgs/editenv.svg)


Expand Down
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,16 @@
[English](README-en.md) | [简体中文](README.md)
</div>

在终端与 ChatGPT 交互,随时随地调用 ChatGPT。
AskChat 是一个通过命令行运行的,无界面的 ChatGPT 交互工具,随时随地调用 ChatGPT。

在终端调用:

![hello](docs/assets/svgs/hello.svg)

在 Jupyter Notebook 中调用:

![jupyter](docs/assets/jupyter.gif)

## 安装及配置

```bash
Expand Down Expand Up @@ -59,15 +65,19 @@ ask hello world
### 使用示例

1. API 调试,测试默认参数和返回结果。

![debug](docs/assets/svgs/debug.svg)

2. 获取可用模型列表。

![validmodels](docs/assets/svgs/validmodels.svg)

3. 多轮对话,保存对话,加载对话等。

![chatlog](docs/assets/svgs/chatlog.svg)

4. 指定参数,使用不同的模型和 API。

![para-models](docs/assets/svgs/para-models.svg)

### 对话管理
Expand Down Expand Up @@ -123,10 +133,12 @@ ask hello world
### 示例

1. 创建,查看,激活和删除渠道

![askenv](docs/assets/svgs/askenv.svg)

2. 编辑渠道
![askenv-config](docs/assets/svgs/editenv.svg)

![askenv-config](docs/assets/svgs/editenv.svg)


### 基本用法
Expand Down
Binary file added docs/assets/jupyter.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c23b443

Please sign in to comment.