Skip to content

Commit 2fce74b

Browse files
author
AiQL.com
authored
Update README.md
1 parent d683665 commit 2fce74b

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,42 @@ By simplifying the structure and key functions, developers can quickly set up an
88

99
## How to use
1010

11-
### Option 1: Goto demo [AIQL](https://chat.aiql.com/)
11+
#### Option 1: Goto demo [AIQL](https://chat.aiql.com/)
1212
> The demo will use `Qwen 2.5` by default
1313
14-
### Option 2: Download [Index](./index.html) and open it locally (recommended)
14+
#### Option 2: Download [Index](./index.html) and open it locally (recommended)
1515

16-
### Option 3: Deploy your own Chatbot by [Docker](https://hub.docker.com/repository/docker/aiql/chat-ui/tags?page=1&ordering=last_updated)
16+
#### Option 3: Deploy your own Chatbot by [Docker](https://hub.docker.com/repository/docker/aiql/chat-ui/tags?page=1&ordering=last_updated)
1717
```shell
1818
docker run -p 8080:8080 -d aiql/chat-ui
1919
```
2020

21-
### Option 4: fork this repo and link it to [Cloudflare pages](https://developers.cloudflare.com/pages)
21+
#### Option 4: fork this repo and link it to [Cloudflare pages](https://developers.cloudflare.com/pages)
2222
- demo https://www2.aiql.com
2323

2424
## How to config
2525

26-
By default, the Chatbot will use API format as OpenAI Chatgpt. You can insert your OpenAI `API Key` and use it directly.
26+
By default, the Chatbot will use API format as OpenAI ChatGPT.
2727

28-
Or change the `Endpoint` in configuration to use API from other vendors
28+
You can insert your OpenAI `API Key` and change the `Endpoint` in configuration to use API from any other vendors
2929

30-
> You can download the config template from [example](./example/config) and use it for quick configuration
30+
You can also download the config template from [example](./example/config) and insert your `API Key`, then use it for quick configuration
3131

3232
## Trouble Shooting
3333

3434
If you're experiencing issues opening the page and a simple refresh isn't resolving the issue, please take the following steps:
3535

36-
### 1. Right-click your browser page and go to the `Network` section.
37-
### 2. Right-click on section table and clear your browser's cache and cookies to ensure you have the latest version of the page.
38-
### 3. Additionally, inspect the browser's Network section to see which resources are failing to load due to your location. This will provide you with more specific information about the issue.
36+
### Reset Interface Configuration
37+
1. Click `Refresh` icon on the upper right of `Interface Configuration`
38+
39+
### Reset All Configuration
40+
1. Click hidden botton on the right side of the index page
41+
2. Click `Reset All Config` icon
42+
43+
### Reset Cache
44+
1. Right-click your browser page and go to the `Network` section.
45+
2. Right-click on section table and clear your browser's cache and cookies to ensure you have the latest version of the page.
46+
3. Additionally, inspect the browser's Network section to see which resources are failing to load due to your location. This will provide you with more specific information about the issue.
3947

4048

4149
## Demo

0 commit comments

Comments
 (0)