linkbomber

discord bot that cleans tracking elements from messages
Download | Log | Files | Refs | README | LICENSE

README.md (1643B)

      1 # Linkbomber
      2 
      3 Discord bot that cleans tracking elements from messages
      4 
      5 You can invite the bot to your server
      6 [here](https://discord.com/oauth2/authorize?client_id=1336105313589395616&scope=bot&permissions=67584).
      7 
      8 ## About
      9 
     10 ![graphic showing how YouTube source identifiers work](img/sourceidentifier.png)
     11 
     12 Many websites use tracking elements in the URL (e.g.
     13 `https://example.com?utm_source=newsletter1&utm_medium=email&utm_campaign=sale`)
     14 to mark your online activity. All those tracking codes are not necessary for
     15 a website to be displayed or work correctly and can therefore be
     16 removed—that is exactly what Linkbomber does. 
     17 
     18 Another common example are Amazon URLs. If you search for a product on
     19 Amazon you will see a very long URL, such as
     20 `https://www.amazon.com/dp/exampleProduct/ref=sxin_0_pb?__mk_de_DE=ÅMÅŽÕÑ&keywords=tea&pd_rd_i=exampleProduct&pd_rd_r=8d39e4cd-1e4f-43db-b6e7-72e969a84aa5&pd_rd_w=1pcKM&pd_rd_wg=hYrNl&pf_rd_p=50bbfd25-5ef7-41a2-68d6-74d854b30e30&pf_rd_r=0GMWD0YYKA7XFGX55ADP&qid=1517757263&rnid=2914120011`
     21 
     22 Indeed most of the above URL are tracking codes. Once Linkbomber has cleaned
     23 the address, it will look like this:
     24 `https://www.amazon.com/dp/exampleProduct`
     25 
     26 ## Usage
     27 
     28 By default, the bot will automatically strip tracking elements from any URL
     29 it supports, this feature can be disabled with the command: `/toggle`. Then,
     30 to use the functionality manually, just use the command `/bomb` which will
     31 strip the latest link posted in a channel of its tracking elements.
     32 
     33 ## Setup
     34 
     35 1. Clone the repository
     36 2. Build the program with `go build .`
     37 3. Run the program `./linkbomber -token <DISCORD_BOT_TOKEN>`