diff --git a/README.md b/README.md new file mode 100644 index 0000000..9af0067 --- /dev/null +++ b/README.md @@ -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