Skip to content

Commit

Permalink
feat: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xuyecan committed Jun 10, 2024
1 parent 0193c70 commit bf3a9c7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ Here is how to get those api-keys:
![Main Config](assets/main_config.png)
3. Make sure the endpoint is correct.
![Endpoint Config](assets/endpoint_config.png)
4. Start using it. Tips: You can add extra Hotkey Triggers for opening chat history or starting a new chat, that would bring smoother user experience.
4. Enjoy.
> Tip: Enhance the user experience by adding hotkey triggers. By default, ctrl + shift + z is preset to open the chat history, while ctrl + shift + x starts a new chat. However, feel free to customize these hotkeys according to your preference.
![Ask Chathub](assets/ask_chathub.png)
![Chat](assets/chat.png)
![Chat History](assets/history.png)
14 changes: 11 additions & 3 deletions info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -1396,7 +1396,7 @@ fi</string>
</dict>
</array>
<key>readme</key>
<string># Alfred-Chathub
<string># &lt;img src='icon.png' width='45' align='center' alt='icon'&gt; Alfred-Chathub
A chat tool that integrates multiple popular large language model (LLM) services, including OpenAI, Anthropic, Gemini, etc. Currently supports:
- [x] OpenAI
Expand All @@ -1411,14 +1411,22 @@ With the release of Alfred version 5.5, Alfred officially provided the [ChatGPT
1. You need to choose an LLM service, register an account on its official website, and obtain an API Key.
2. Install python3, ensuring that `/usr/bin/env python3 -c "import sys; print(sys.executable)"` prints the correct path to your python3.
## Setup
Here is how to get those api-keys:
- OpenAI: https://platform.openai.com/api-keys
- Anthropic: https://console.anthropic.com/settings/keys
- Gemini: https://ai.google.dev/gemini-api/docs/api-key
- (Qwen)通义千问: https://help.aliyun.com/zh/dashscope/developer-reference/activate-dashscope-and-create-an-api-key
## Usage
1. Install the workflow. Typically, you just need to download the latest version from the release page and click to install it.
2. Perform basic configuration. You need to select a provider, and set the corresponding Api Key, Model. If necessary, set a proxy.
![Main Config](assets/main_config.png)
3. Make sure the endpoint is correct.
![Endpoint Config](assets/endpoint_config.png)
4. Start using it.
4. Enjoy.
&gt; Tip: Enhance the user experience by adding hotkey triggers. By default, ctrl + shift + z is preset to open the chat history, while ctrl + shift + x starts a new chat. However, feel free to customize these hotkeys according to your preference.
![Ask Chathub](assets/ask_chathub.png)
![Chat](assets/chat.png)
![Chat History](assets/history.png)</string>
Expand Down

0 comments on commit bf3a9c7

Please sign in to comment.