Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CrazyMarvin authored Apr 25, 2021
1 parent b34684a commit 4417b1f
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
![healthchecks.io](https://img.shields.io/endpoint?label=Indebted%20Colleagues&style=flat-square&url=https%3A%2F%2Fhealthchecks.io%2Fbadge%2F396c7d03-faf7-4562-9f83-1194d0%2FFvpTwwzZ%2FIndebtedColleagues.shields)
[![Telegram Indebted Colleagues Bot](https://img.shields.io/badge/Telegram-Bot-blue?logo=telegram)](https://t.me/IndebtedColleaguesBot)
![healthchecks.io](https://img.shields.io/endpoint?label=Indebted%20Colleagues&style=flat&url=https%3A%2F%2Fhealthchecks.io%2Fbadge%2F396c7d03-faf7-4562-9f83-1194d0%2FFvpTwwzZ%2FIndebtedColleagues.shields)
[![License](https://img.shields.io/github/license/Crazy-Marvin/IndebtedColleaguesTelegramBot)](https://github.com/Crazy-Marvin/IndebtedColleaguesTelegramBot/blob/trunk/LICENSE)
[![Last commit](https://img.shields.io/github/last-commit/Crazy-Marvin/IndebtedColleaguesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/IndebtedColleaguesTelegramBot/commits)
[![Releases](https://img.shields.io/github/downloads/Crazy-Marvin/IndebtedColleaguesTelegramBot/total.svg?style=flat)](https://github.com/Crazy-Marvin/IndebtedColleaguesTelegramBot/releases)
[![Latest tag](https://img.shields.io/github/tag/Crazy-Marvin/IndebtedColleaguesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/IndebtedColleaguesTelegramBot/tags)
[![Issues](https://img.shields.io/github/issues/Crazy-Marvin/IndebtedColleaguesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/IndebtedColleaguesTelegramBot/issues)
[![Pull requests](https://img.shields.io/github/issues-pr/Crazy-Marvin/IndebtedColleaguesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/IndebtedColleaguesTelegramBot/pulls)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/44ceb7c5203d4c248aee2d5e87016d92)](https://www.codacy.com/gh/Crazy-Marvin/IndebtedColleaguesTelegramBot/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Crazy-Marvin/IndebtedColleaguesTelegramBot&utm_campaign=Badge_Grade)
![No Dependencies](https://img.shields.io/badge/Dependencies-None-brightgreenChat)

# Indebted Colleagues Telegram Bot

Telegram Bot That Tracks What Colleagues Owe You

### Requirements

- Token from [@Botfather](https://telegram.me/botfather)
- SSL certificate (I recommend [Let's Encrypt](https://letsencrypt.org/))
- Webserver running PHP (tested with [Apache](https://httpd.apache.org/), [NGINX](https://www.nginx.com/) and [Caddy](https://caddyserver.com/) but others should work too)
- [MariaDB](https://mariadb.org/) database
- [Healthchecks](https://healthchecks.io/#php) URL (optional)

### Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

More details and contact info can be found in the [CONTRIBUTING.md](https://github.com/Crazy-Marvin/IndebtedColleaguesTelegramBot/blob/trunk/.github/CONTRIBUTING.md)

### License

[MIT License](https://choosealicense.com/licenses/mit/)

0 comments on commit 4417b1f

Please sign in to comment.