Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gusye1234 committed Nov 30, 2023
1 parent 4c86a21 commit 2f80358
Showing 1 changed file with 23 additions and 15 deletions.
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,20 @@
<p><strong>Spotlight app for ChatGPT</strong></p>
<p>
<a href="https://github.com/gusye1234/chat-spot/releases/tag/v0.0.2">
<img src="https://img.shields.io/badge/version-v0.0.2 beta-blue">
<img src="https://img.shields.io/badge/version-v0.0.3 beta-blue">
</a>
<a href="https://github.com/gusye1234/chat-spot/actions?query=workflow%3APublish">
<img src="https://github.com/gusye1234/chat-spot/actions/workflows/build.yml/badge.svg">
</a>
<a href="https://github.com/gusye1234/chat-spot">
<img src="https://img.shields.io/badge/platform-macOS-green">
</a>
<a href="https://github.com/gusye1234/chat-spot">
<a href="https://github.com/gusye1234/chat-spot">
<img src="https://img.shields.io/badge/platform-windows-green">
</a>
<a href="https://github.com/gusye1234/chat-spot">
<img src="https://img.shields.io/badge/platform-linux-green">
</a>
</p>
</div>

Expand All @@ -23,44 +26,48 @@


<p align="center">
<img src="https://github.com/gusye1234/chat-spot/releases/download/v0.0.1/show.gif" alt="show" style="border-radius:20px;">
<img src="https://github.com/gusye1234/chat-spot/releases/download/v0.0.3/show.gif" alt="show" style="border-radius:20px;">
</p>




ChatSpot is an AI-powered, Spotlight assistant designed to help users complete tasks quickly and efficiently. Anytime or anywhere, press `command/ctrl + alt + k` and ChatSpot is always ready to assist.


ChatSpot🥸 is an AI-powered, Spotlight assistant designed to help users complete tasks quickly and efficiently. Anytime or anywhere, press `command/ctrl + alt + k` and ChatSpot is always ready to assist.

By default, anything said by ChatSpot will be automatically copied. So all you need is:

1. Toggle ChatSpot with gobal shortcut `command/ctrl + alt + k`
2. Ask question and wait the streaming output finished
3. Untoggle ChatSpot with gobal shortcut `command/ctrl + alt + k`, and the focus will be back to your previsous working place, where you can paste the response from ChatGPT

ChatSpot also supports custom prompts. You can use "/" to invoke a window customized with your prompt.
ChatSpot supports the latest GPT-4 vision, you can snip anywhere of your screen and ask about it🤯:

<p align="center">
<img src="https://github.com/gusye1234/chat-spot/releases/download/v0.0.1/prompt.gif" alt="prompt" style="border-radius:20px;">
<img src="https://github.com/gusye1234/chat-spot/releases/download/v0.0.3/vision.gif" alt="show" style="border-radius:20px;">
</p>


You can checkout details shortcuts and other functions in the menu bar:
ChatSpot also supports custom prompts📒. You can use "/" to invoke a window customized with your prompt:

<p align="center">
<img src="https://github.com/gusye1234/chat-spot/releases/download/v0.0.2/menu.jpg" alt="prompt" style="border-radius:10px;">
<img src="https://github.com/gusye1234/chat-spot/releases/download/v0.0.3/prompt.gif" alt="prompt" style="border-radius:20px;">
</p>




## Get Started

> **Using ChatSpot requires your own OpenAI key to connect to ChatGPT.**
Download the app

| Platform | Tested Supports | Download |
| -------- | ------------------ | ------------------------------------------------------------ |
| MacOS | Support 13.5.2+ | [Release](https://github.com/gusye1234/chat-spot/releases/tag/v0.0.2) |
| Windows | Haven't tested yet | [Release](https://github.com/gusye1234/chat-spot/releases/tag/v0.0.2) |
| Linux | Haven't tested yet | / |
| Platform | Tested Supports | Download |
| -------- | --------------- | ------------------------------------------------------------ |
| MacOS | 13.5.2+ | [Release](https://github.com/gusye1234/chat-spot/releases/tag/v0.0.3) |
| Windows | Windows 10 | [Release](https://github.com/gusye1234/chat-spot/releases/tag/v0.0.3/ChatSpot-Setup-0.0.3.exe) |
| Linux | Ubuntu 22.04 | [Release](https://github.com/gusye1234/chat-spot/releases/tag/v0.0.3/ChatSpot-0.0.3.AppImage) |



Expand All @@ -83,4 +90,5 @@ pnpm package

## Credits

* Thanks to [Electron React Boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate) , I saved a lot of time for the inital setup.i
* Thanks to [Electron React Boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate) , I saved a lot of time for the inital setup.
* Thanks [electron-screenshots](https://github.com/nashaofu/screenshots) (readme in Chinese), it has supported the screenshot function of ChatSpot.

0 comments on commit 2f80358

Please sign in to comment.