Skip to content

Commit

Permalink
Merge pull request #2 from ozgen/add-readme-explanation
Browse files Browse the repository at this point in the history
Add readme explanation
  • Loading branch information
ozgen authored Oct 8, 2024
2 parents b0bbdde + f0d0913 commit 9a29421
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,20 @@ java -jar target/binance-telegram-bot-0.0.1-SNAPSHOT.jar
1. **Create a Telegram Bot**: Follow the instructions on [Telegram's official documentation](https://core.telegram.org/bots#creating-a-new-bot) to create a new bot.
2. **Generate a Bot Token**: Use this [guide](https://medium.com/geekculture/generate-telegram-token-for-bot-api-d26faf9bf064) to generate a token for your Telegram bot.

---

## Example of the Bot in Action

Here's an example of how the bot works when a user enters a symbol and selects a trading strategy:

![Telegram Bot Example](./img/example.jpeg)

1. The user enters a trading pair (e.g., `btcusdt`).
2. The bot asks the user to choose a trading strategy.
3. After selecting a strategy, the bot processes the signal and provides a response with the trading signal details.

---

## Test Coverage

### Running Tests
Expand Down
Binary file added img/example.jpeg
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 9a29421

Please # to comment.