Skip to content

Commit 560db02

Browse files
committed
docs: 📝 Updated README
1 parent b029da0 commit 560db02

File tree

6 files changed

+21
-7
lines changed

6 files changed

+21
-7
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,36 @@ Currently, catchat supports [OpenAI](https://openai.com/) and [Azure OpenAI](htt
1010

1111
## Features
1212

13-
- Stream Chatting
14-
- Markdown Rendering
15-
- Profile Management (Create, Delete, List)
13+
### Stream Message
14+
15+
![](assets/stream-message.gif)
16+
17+
### Markdown Rendering
18+
19+
![](assets/markdown-rendering.gif)
20+
21+
### Profile Lazy Management (Create, Delete, List)
22+
23+
![](assets/profile-lazy-management.gif)
1624

1725
## Installation
1826

1927
You can download the latest version manually from [latest release](https://github.com/imkcat/catchat/releases/latest).
2028

2129
## Usage
2230

23-
TODO
31+
1. Run `catchat` on you terminal
32+
2. Choose profile (program will ask you to create a new profile if there is no profile yet)
33+
3. That's it!
34+
2435

25-
## Examples
36+
## FAQ
2637

27-
TODO
38+
1. “catchat” can’t be opened because Apple cannot check it for malicious software.
39+
40+
Go to `System Settings` -> `Privacy & Security` -> `Security`, click `Allow Anyway` button
2841

42+
![](assets/macos-execute-allow.png)
2943

3044
## Contributing
3145

assets/macos-execute-allow.png

10.6 KB
Loading

assets/markdown-rendering.gif

2.84 MB
Loading

assets/profile-lazy-management.gif

1.88 MB
Loading

assets/stream-message.gif

3.14 MB
Loading

internal/config/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,6 @@ func (config *Config) DeleteProfile(names []string) error {
135135
if err != nil {
136136
return err
137137
}
138-
fmt.Printf("%d profiles deleted", len(names))
138+
fmt.Printf("%d profiles deleted\n", len(names))
139139
return nil
140140
}

0 commit comments

Comments
 (0)