-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated ReadMe with usage instructions
- Loading branch information
Showing
1 changed file
with
12 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,17 @@ | ||
# Züri Trash Bot | ||
|
||
Züri Trash Bot is a convenient way to query paper. cardboard, and textile collection dates for people living in Zurich. The bot also support querying dates for the next cargo tram and E-tram. | ||
Züri Trash Bot is a [Telegram](https://telegram.org) bot, which offers a convenient way to query paper :newspaper:, cardboard :package:, and textile :shirt: collection dates for people living in Zurich. The bot also support querying dates :calendar: for the next cargo tram and E-tram :train:. | ||
|
||
## Setup | ||
## Usage | ||
|
||
* clone the git repository | ||
* create a virtual environment | ||
* install the requirements from `requirement.txt` (in the virtual environment) | ||
* copy `config.ini.example` to `config.ini` and configure your telegram bot token | ||
* run `trashbot.py` from the `src` folder | ||
Visit https://t.me/zh_trashbot or use `@zh_trashbot` directly from within Telegram. | ||
|
||
## Deployment | ||
|
||
You don't need to deploy the bot to use it. For using the bot, just follow the link above. If - for whatever reason - you want to deploy (a copy of) this bot, you will need to: | ||
|
||
- clone this repository, | ||
- create a virtual environment (use python 3.6 or later), | ||
- install the dependencies (into your virtual environment): `pip install -r requirements.txt`, | ||
- copy `config.ini.example` to `config.ini`, get a [Telegram bot token](https://core.telegram.org/bots#creating-a-new-bot) and configure it in `config.ini`, | ||
- run `python trashbot.py` from within the `src/` folder (or submit a PR to fix the fact that we currently have a hard-coded relative path to the config file) |