Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bennhuang committed Dec 11, 2023
1 parent dc59e7d commit 73255bd
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 17 deletions.
44 changes: 28 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,7 @@
</a>
</p>

<table>
<tr>
<td>
<img src='./doc/snapshot2.png' />
</td>
<td>
<img src='./doc/snapshot4.png' />
</td>
</tr>
</table>

## Download
## ⏬ Download

<table>
<tr>
Expand Down Expand Up @@ -73,19 +62,39 @@

Visit the **[GitHub Releases](https://github.com/Bin-Huang/chatbox/releases)** to download the latest version or any previous release.

## Features
## 🌟 Features

<img src="./dec/../doc/demo_desktop_1.jpg" alt="App Screenshot" style="box-shadow: 2px 2px 10px rgba(0,0,0,0.1); border: 1px solid #ddd; border-radius: 8px; width: 700px" />

<img src="./dec/../doc/demo_desktop_2.jpg" alt="App Screenshot" style="box-shadow: 2px 2px 10px rgba(0,0,0,0.1); border: 1px solid #ddd; border-radius: 8px; width: 700px" />

<img src="./dec/../doc/demo_desktop_3.jpg" alt="App Screenshot" style="box-shadow: 2px 2px 10px rgba(0,0,0,0.1); border: 1px solid #ddd; border-radius: 8px; width: 700px" />

<!-- <table>
<tr>
<td>
<img src="./dec/../doc/demo_mobile_1.png" alt="App Screenshot" style="box-shadow: 2px 2px 10px rgba(0,0,0,0.1); border: 1px solid #ddd; border-radius: 8px; height: 300px" />
</td>
<td>
<img src="./dec/../doc/demo_mobile_2.png" alt="App Screenshot" style="box-shadow: 2px 2px 10px rgba(0,0,0,0.1); border: 1px solid #ddd; border-radius: 8px; height: 300px" />
</td>
</tr>
</table> -->

- Enhanced prompting capability
- Data is stored locally and will not be lost
- Supports multiple cutting-edge LLM models and providers, such as OpenAI, Azure OpenAI and ChatGLM-6B
- Supports Dall-E-3, real-time image generation
- Keyboard shortcuts for improved productivity
- Markdown & Code Highlighting
- Prompt Library, Message Quoting
- Streaming reply
- Ergonomic UI design & Night Mode
- Suitable for team collaboration, supporting the sharing of OpenAI API resources within the team. View [tutorial](./team-sharing/README.md)
- Providing installation packages, no deployment required
- Free and open source
- Cross-platform, available on Windows, Mac, Linux
- Web version, available on any device with a browser
- More...

## FAQ

Expand Down Expand Up @@ -128,10 +137,13 @@ At first, I didn't know that it would be so popular. I listened to the feedback
- [x] Claude
- [x] Temperature Setting
- [x] Conversation Special Settings
- [x] Custom Model
- [x] OpenAI Custom Model
- [x] Dall-E-3
- [x] Message Search
- [x] Data Export
- [ ] Mobile(Android, iOS)
- [ ] Talk with files
- [ ] Talk with URLs
- [ ] Mobile(Android, iOS)
- [ ] Cross-device synchronization
- [ ] threads(like Slack)
- More...
Expand Down
Binary file added doc/demo_desktop_1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/demo_desktop_2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/demo_desktop_3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"build": "tauri build",
"tauri": "tauri",
"lint": "eslint . --ext .js,.jsx,.ts,.tsx",
"prettier": "prettier -w ."
"prettier": "npx prettier -w ."
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 73255bd

Please sign in to comment.