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 3924092 commit 6b8c445
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
[![Telegram New Game Releases Bot](https://img.shields.io/badge/Telegram-Bot-blue?logo=telegram)](https://t.me/NewGameReleasesBot)
![healthchecks.io](https://img.shields.io/endpoint?label=Game%20Releases&style=flat-square&url=https%3A%2F%2Fhealthchecks.io%2Fbadge%2F396c7d03-faf7-4562-9f83-1194d0%2FBgFs26OS%2FGameReleases.shields)
# GameReleasesTelegramBot
A bot for Telegram that informs about new releases
[![License](https://img.shields.io/github/license/Crazy-Marvin/GameReleasesTelegramBot)](https://github.com/Crazy-Marvin/GameReleasesTelegramBot/blob/trunk/LICENSE)
[![Last commit](https://img.shields.io/github/last-commit/Crazy-Marvin/GameReleasesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/GameReleasesTelegramBot/commits)
[![Releases](https://img.shields.io/github/downloads/Crazy-Marvin/GameReleasesTelegramBot/total.svg?style=flat)](https://github.com/Crazy-Marvin/GameReleasesTelegramBot/releases)
[![Latest tag](https://img.shields.io/github/tag/Crazy-Marvin/GameReleasesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/GameReleasesTelegramBot/tags)
[![Issues](https://img.shields.io/github/issues/Crazy-Marvin/GameReleasesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/GameReleasesTelegramBot/issues)
[![Pull requests](https://img.shields.io/github/issues-pr/Crazy-Marvin/GameReleasesTelegramBot.svg?style=flat)](https://github.com/Crazy-Marvin/GameReleasesTelegramBot/pulls)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8c456ffe4305419aac029af0d975122c)](https://www.codacy.com/gh/Crazy-Marvin/GameReleasesTelegramBot/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Crazy-Marvin/GameReleasesTelegramBot&utm_campaign=Badge_Grade)
![No Dependencies](https://img.shields.io/badge/Dependencies-None-brightgreenChat)

# New Game Releases Telegram Bot

A bot for [Telegram](https://telegram.org/) that informs about new releases of [PC](https://www.reddit.com/r/pcmasterrace/), [Xbox](https://www.xbox.com/), [Android](https://www.android.com/), [PlayStation](https://www.playstation.com/de-de/), [iOS](https://www.apple.com/ios/) and [Switch](https://www.nintendo.com/) games.

A huge thanks goes to [IGDB](https://www.igdb.com/discover) (operated by [Twitch](https://www.twitch.tv/) and [Amazon](https://www.amazon.com/)) for the [data](https://www.igdb.com/api).

### Requirements

- Token from [@Botfather](https://telegram.me/botfather)
- SSL certificate (I recommend [Let's Encrypt](https://letsencrypt.org/))
- Webserver running [PHP](https://www.php.net/) and [Python](https://www.python.org/) (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/GameReleasesTelegramBot/blob/trunk/.github/CONTRIBUTING.md)

### License

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

0 comments on commit 6b8c445

Please sign in to comment.