Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lisiur committed Apr 25, 2023
1 parent e6bb88a commit 341fd72
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ jobs:
owner: context.repo.owner,
repo: context.repo.repo,
release_id: process.env.release_id,
name: `chat-wizard-cli_v${process.env.version}_${process.env.target}.exe`,
name: `chat-wizard-cli_${process.env.target}.exe`,
data: file,
})
- name: upload cli asset
Expand All @@ -139,7 +139,7 @@ jobs:
owner: context.repo.owner,
repo: context.repo.repo,
release_id: process.env.release_id,
name: `chat-wizard-cli_v${process.env.version}_${process.env.target}`,
name: `chat-wizard-cli_${process.env.target}`,
data: file,
})
Expand Down
49 changes: 45 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,28 @@

## Screenshots

<img src="./assets/slash-command.png" />

<details>
<summary>View More</summary>
### Casual Chat
<img src="./assets/casual-chat.png" />
<img src="./assets/slash-command.png" />

### Topic Chat
<img src="./assets/chat.png" />

### Local Prompt
<img src="./assets/prompt.png" />

### Prompt Market
<img src="./assets/prompt-market.png" />

### Plugins
<img src="./assets/plugins.png" />

### Setting
<img src="./assets/setting.png" />

### Tray Window
<img src="./assets/tray-window.png" />
</details>

## Features

Expand Down Expand Up @@ -118,6 +129,36 @@
ChatWizard has built-in upgrade support, and each time you restart the application, it automatically checks for any new releases. If a new version is available, a small red dot will be displayed in the lower left corner.
## Plugin
You need to install chat-wizard-cli to use plugin.
### Install chat-wizard-cli
- [Apple Intel](https://github.com/lisiur/ChatWizard/releases/download/v0.0.77/chat-wizard-cli_v0.0.77_x86_64-apple-darwin)
- [Apple Silicon](https://github.com/lisiur/ChatWizard/releases/download/v0.0.77/chat-wizard-cli_v0.0.77_aarch64-apple-darwin)
- [Windows](https://github.com/lisiur/ChatWizard/releases/download/v0.0.77/chat-wizard-cli_v0.0.77_x86_64-pc-windows-msvc.exe)
- [Linux](https://github.com/lisiur/ChatWizard/releases/download/v0.0.77/chat-wizard-cli_v0.0.77_x86_64-unknown-linux-gnu)
### How to use
1. You need to rename the downloaded binary file to a more user-friendly name and add it to your environment variables. Let us assume that the binary file is named chat-wizard-cli.
2. Then you need to install plugin in ChatWizard App. For instance, assuming the plugin named `commit-summary` has already been installed.
3. And finally you can execute: `chat-wizard-cli exec commit-summary` in terminal.
<img src="./assets/plugin.png" />
<img src="./assets/plugin2.png" />
### Q&A
**1. Why chat-wizard-cli is so large, almost more then 10 MB**
As CLI and GUI programs are completely separate, you can easily install and use plugins with just CLI. However, the current configuration of CLI is still dependent on GUI, which will gradually be improved in the future.
**2. Where is the plugin source code**
Check this [repo](https://github.com/ChatWizard/plugins)
## Development
- dev
Expand Down
Binary file added assets/plugin.png
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 assets/plugin2.png
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 assets/plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 341fd72

Please sign in to comment.