Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mazzz1y committed Aug 13, 2023
1 parent 15f658a commit 85f4bc2
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Matrix GPT is a Matrix chatbot that uses OpenAI for real-time chatting.
![](./.github/img.png)
## Installation

You can download the binary from [Releases](https://github.com/mazzz1y/matrix-gpt/releases) page

### Docker

Run the Docker container:
Expand Down Expand Up @@ -39,20 +41,14 @@ information.

## Usage

Follow these simple steps to interact with the bot:

1. **Add the bot to your contact list.**

After the bot has been added, begin your interaction by sending your questions, commands or comments.

2. **Send commands.**

You can use the following commands to communicate with the bot:
This bot supports the following commands:

- **Generate an Image:** `!image [text]` - This command creates an image based on the provided text.
- **Reset User History:** `!reset [text]` - This command resets the user's command history. If text is provided following the reset command, the bot will generate a GPT-based response based on this text.
- **Send a Text Message:** `[text]` - Send any text to the bot and it will generate a GPT-based response relevant to your text.
- `!image [text]`: This command will create and return an image based on the text you provide.
- `!reset [text]`: This command will reset the user's history. If you provide text after the `!reset` command, the bot generates a response using GPT, based on this input text.
- `[text]`: If you simply input text without any specific command, the bot will automatically generate a GPT-based response related to the text provided.

3. **Identify error responses.**
### Additional Notes

If there are any errors in processing your requests or commands, the bot will respond with a ❌ reaction.
- You can implement shortcuts for each command by using the first letter of the command as an alias. For example, `!i` can be used in place of the `!image` command.
- If you need to stop any ongoing processing, you can just delete your message from the chat.
- In case of errors, the bot reacts with a ❌. If you notice this, please check logs.

0 comments on commit 85f4bc2

Please sign in to comment.