Skip to content

Commit

Permalink
[skip ci] Updated reame (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattiascibien authored Oct 28, 2022
1 parent 031a0be commit 6724e0c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@ Configurable apps for running Telegram Bots that responds to photo Image Queries

## Bots using this framework

* [@mikesmother_bot](https://telegram.me/mikesmother_bot) - A joke bot that sends images of Cara Buono, Mike's mother in Stranger Things.
* [@piselli_bot](https://telegram.me/piselli_bot) - A joke bot that sends images of beans
* [@Robertpattinbot](https://telegram.me/Robertpattinbot) - A joke bot that sends images of Robert Pattinson
* ... (open a PR to be featured here if you want to be featured here)

## Deveopment

* Register your bot(s) using [@botfather](https://telegram.me/botfather).
* Add a configuration file inside the project directory (use the one provided as an example)
* Choose a prefix for your bot, it will be used to find the secure settings needed using environment variables
* Add the environment variable `<BOT_PREFIX>_TELEGRAM_KEY` and set its value to the configuration token given by @botfather
* Add any required environment variables for the chosen Image Search Provider; at the moment only Bing is supported so you should set the value of `<BOT_PREFIX>_BING_KEY` to your API key (you can read more [here](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-web-search/))
* Compile and run the project.
* If needed you can override the config directory by passing it as a command-line parameter, i.e: `./image-search-bot.exe /opt/myconfigs`
* Choose an image provider and add it to your config (Bing at the moment does now work since the C# library of Bing is broken)
* If needed you can override the config directory by passing it as a command-line parameter, i.e: `./image-search-bot.exe /opt/myconfigs`

## Usage

Expand Down

0 comments on commit 6724e0c

Please sign in to comment.