Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
mguaylam committed Jul 13, 2024
1 parent 7b7b70d commit f6be9cd
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,25 @@

## Goal

The goal of this Telegram bot is to provide an interface for launching a Communauto car search on Telegram. When it finds at least one car, the bot will return the number of cars found.
The goal of this Telegram bot is to provide an interface for launching a Communauto car search on Telegram. When it finds at least one car, the bot will return the number of cars found. Interaction with the bot is in french.

## Commands

- **/help**: View available commands.
- **/start**: Begin a discussion with the bot to set search parameters.
- **/restart**: Start a new search with the same parameters as the previous one.
- **/aide**: View available commands.
- **/chercher**: Begin a discussion with the bot to set search parameters.
- **/recommencer**: Start a new search with the same parameters as the previous one.

## Usage

To use this bot, you need to define an environment variable named _TOKEN_COMMUNAUTOSEARCH_BOT_ in a .env file and set its value to your Telegram token.
To use this bot, you need to define an system environment variable named _TOKEN_COMMUNAUTOSEARCH_BOT_ and set its value to your Telegram token.
After that, run `go run main.go` to launch the bot.
Then, search for the bot on Telegram to start a discussion with it.

## Dependencies

- [communautofinder](https://github.com/craftlion/communautofinder)
- [communautofinder](https://github.com/mguaylam/communautofinder)
- [telegram-bot-api](https://github.com/go-telegram-bot-api/telegram-bot-api)

## Thank you

Thanks to craftlion for writing all of this. I forked his project to adapt it to my needs.

0 comments on commit f6be9cd

Please sign in to comment.