diff --git a/README.md b/README.md index dd3fcea..7597fde 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# Refactoring -The code needs to be refactored. Soon we will specify a date and will start working on it. \ No newline at end of file +# UrlExpander +A Telegram bot made to unshort shortened links from services like bit.ly, grabify and others. Which can get annoying waiting 5 while viewing some sort of ads, auto downloading files, your IP getting grabbed, etc... + +# Setuping +You will need the following data to proceed: +- bot token, you can get at [BotFather](t.me/botfather) +- api id, you can get yours at [Telegram Website](my.telegram.org) +- api hash, you can get yours at [Telegram Website](my.telegram.org) + +Then put each in the respective parameter in the main.ini config file. + +# Final notes +Thank you for your interest. TerabitSec wishes you a very nice day. \ No newline at end of file