Add a nice README

Signed-off-by: baalajimaestro <me@baalajimaestro.me>
This commit is contained in:
baalajimaestro 2022-04-11 11:52:47 +05:30
parent 278a256d64
commit fbda01b355
Signed by: baalajimaestro
GPG key ID: F93C394FE9BBAFD5

23
README.md Normal file
View file

@ -0,0 +1,23 @@
# Nim Censor Bot
This Telegram Bot, can easily enable you to send NSFW/Spoiler Media in a chat that is not intended for it.
It makes the viewer to view it in the personal message of the bot.
You can send it photo, video, album, gif, sticker and forward the response from the bot to any chat.
A live version is available [here](https://t.me/nonozonebot)
Configuration Variables (All are fetched from Environment Variables):
- `TELEGRAM_TOKEN`: Get one from @BotFather
- `DB_HOST`: A filename for sqlite, or url for postgres host
- `DB_USER`: DB Username, for postgres only
- `DB_PASS`: DB Password, for postgres only
- `DB_NAME`: DB Name, for postgres only
- `ADMIN_ID`: A comma-separated variable which will allow you and enlisted others to moderate the bot
This bot would not have been possible without the help of:
- @trueleo
- @DavideGalilei
- @yardanico