initial commit

README.md

@@ -0,0 +1,23 @@
+# linkbomber
+
+Discord bot that cleans tracking elements from messages
+
+You can invite the bot to your server [here](https://discord.com/oauth2/authorize?client_id=1336105313589395616&scope=bot&permissions=274877990912).
+
+## Usage
+
+By default, the bot will automatically strip tracking elements from any URL it supports,
+this feature can be disabled with the command: `/toggle`. Then, to use the functionality
+manually, just use the command `/bomb` which will strip the latest link posted in a channel
+of its tracking elements.
+
+## Setup
+
+1. Clone the repository
+2. Create a file named `.env` in the same directory as the bot
+3. Add the following contents to the file
+```
+DISCORD_BOT_TOKEN=your_bot_token_here
+```
+4. Install the dependencies with `pip install -r requirements.txt`
+5. Run the bot with `python main.py`