forked from GauthamramRavichandran/clearurls
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,22 @@ | ||
# ClearURLs BOT | ||
# URL Cleaner Bot | ||
|
||
A (_minimalist_) telegram bot to provide clean urls (i.e., removes any tracking info on the url (looking at you, **Facebook** and **Google** 😉)) | ||
![url_image](https://user-images.githubusercontent.com/19761269/199670096-c4b74d2d-41fb-4fea-9894-a4d865896ed9.jpg) | ||
|
||
[DEMO](https://t.me/ClearURLs_Bot "ClearURLs BOT") | ||
A (_minimalist_) Telegram bot to provide clean URLs and removes any tracking info in the URL. | ||
|
||
This bot utilises two libraries (credits to the creators) | ||
Self-hosted version here: https://t.me/clean_urls_bot | ||
|
||
This bot utilises two libraries (credit to the creators) | ||
|
||
1. Telethon | ||
2. Unalix | ||
|
||
#### Usage, | ||
1. Send a link, bot will reply with a clearURL | ||
2. Add the bot in a group, bot will reply with clearURLs there | ||
1. Send a link and the bot will reply with a clean URL | ||
2. Add the bot in a group and the bot will reply with clean URLs there | ||
|
||
##### Deploy your own bot, | ||
1. Follow this [guide](https://docs.telethon.dev/en/latest/basic/signing-in.html "setup guide") to get `api_id`, `api_hash` and `bot_token` | ||
1. Follow this [guide](https://docs.telethon.dev/en/stable/basic/signing-in.html "setup guide") to get `api_id`, `api_hash` and `bot_token` | ||
2. Replace those values in `CONFIG.py` | ||
3. Create a virtualenv and install the `requirements.txt` | ||
4. Start the bot, `python main_file.py` | ||
|
||
#### Disclaimer | ||
|
||
Copyright (C) 2020 Gauthamram Ravichandran | ||
|
||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU General Public License as published by | ||
the Free Software Foundation, either version 3 of the License, or | ||
(at your option) any later version. | ||
|
||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU General Public License for more details. | ||
|
||
You should have received a copy of the GNU General Public License | ||
along with this program. If not, see <https://www.gnu.org/licenses/>. |