Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SharliBeicon authored Jun 12, 2024
1 parent 3bba087 commit 820f238
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# A fully functional AI Powered Telegram bot

## Supported commands
You can either:
- `/ask` for a specified question.
- `/mediate` to read the last N messages of a chat group and mitigate an argument.

## Environment variables needed
## Setup guide
### Add environment variables
```
- TELOXIDE_TOKEN= "/* Your Telegram Bot API Key */"
- OPENAI_API_KEY= "/* Your OpenAI API Key */"
- OPENAI_ORG_ID= "/* Your OpenAI Organization ID */"
```
### Put these lines into your Cargo.toml
```
[dependencies]
telitairos-bot = "0.1.1"
teloxide = { version = "0.12", features = ["macros"] }
log = "0.4"
pretty_env_logger = "0.4"
tokio = { version = "1.8", features = ["rt-multi-thread", "macros"] }
```

## Supported commands
You can either:
- `/ask` for a specified question.
- `/mediate` to read the last N messages of a chat group and mitigate an argument.


## Basic usage

Expand Down

0 comments on commit 820f238

Please sign in to comment.