Skip to content

Commit 8c3e3de

Browse files
committed
Update README.md
This commit fixes #16
1 parent 3081a8e commit 8c3e3de

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,17 @@
66

77
A simple Python code that connects to OpenAI's ChatGPT and executes the returned results.
88

9+
## Demo
10+
11+
![Demo](images/example.gif)
12+
913
## Key Features 💡
1014

1115
- Interact with your computer using natural language
1216
- Automatically executes the command from the response of ChatGPT
1317
- Good for complex tasks like handling Git and extracting tar files
1418
- No need to search StackOverflow for commands, AiShell has got you covered
1519

16-
### Simple Utility commands 🛠
17-
18-
[![utility](https://asciinema.org/a/556670.svg)](https://asciinema.org/a/556670?speed=5)
19-
20-
### A powerful git assistant 💪🏻👨‍💻💻
21-
22-
[![git assistant](https://asciinema.org/a/556677.svg)](https://asciinema.org/a/556677?speed=5)
23-
2420
## Installation 🔧
2521

2622
```sh
@@ -30,7 +26,7 @@ pip install aishell
3026
## Usage 📝
3127

3228
```sh
33-
python -m aishell --help
29+
aishell --help
3430
```
3531

3632
## Prerequisites 📚
@@ -41,10 +37,23 @@ python -m aishell --help
4137

4238
## Getting Started 🚀
4339

40+
### For those who want to use reverse-engineered `ChatGPT`
41+
42+
1. Login on <https://chat.openai.com/>
43+
1. Get your 'accessToken` from <https://chat.openai.com/api/auth/session>
44+
1. `export CHATGPT_ACCESS_KEY=<your access token>`
45+
1. Enjoy AiShell
46+
47+
### For those who want to use `GPT-3`
48+
4449
1. Create account on OpenAI
4550
1. Go to <https://platform.openai.com/account/api-keys>, Copy API key
4651
1. Set the API key as an environment variable `OPENAI_API_KEY` or inject it directly into the code by editing it.
47-
1. [Install](#installation)
52+
1. Enjoy AiShell
53+
54+
### For those who want to use Official ChatGPT API `gpt-3.5-turbo`
55+
56+
- Currently not supported, but soon will be supported!
4857

4958
## Contributions 💬
5059

images/example.gif

138 KB
Loading

0 commit comments

Comments
 (0)