diff --git a/README.md b/README.md index d117fda..17700d3 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,7 @@ Twoot is a python script that mirrors tweets from a twitter account to a Mastodon account. It is simple to set-up on a local machine, configurable and feature-rich. -**UPDATE 22 NOV 2022** VERSION 2.4 Added command-line option (`-u`) to -remove tracking parameters from URLs included in tweets. A tracking URL is a -normal URL with additional parameters attached to it. These parameters are used -by marketing companies to identify the source of a click and the effectiveness -of a communication campaign. +**UPDATE XX NOV 2022** VERSION 2.5 Added command-line option (`-l`) > Previous updates can be found in CHANGELOG. @@ -25,7 +21,7 @@ of a communication campaign. * Optionally ignore retweets * Allows rate-limiting posts to Mastodon instance -## usage +## Usage ``` twoot.py [-h] -t -i -m @@ -33,7 +29,7 @@ twoot.py [-h] -t -i -m [-d ] [-c ] ``` -## arguments +## Arguments Assuming that the Twitter handle is @SuperDuperBot and the Mastodon account is @superduperbot@botsin.space @@ -42,16 +38,24 @@ is @superduperbot@botsin.space |-------|--------------------------------------------------|--------------------|-----| | -t | twitter account name without '@' | `SuperDuper` | Yes | | -i | Mastodon instance domain name | `botsin.space` | Yes | -| -m | Mastodon username | `superduperbot` | Yes | +| -m | Mastodon username | `sd@example.com` | Yes | | -p | Mastodon password | `my_Sup3r-S4f3*pw` | Yes | | -v | upload videos to Mastodon | *N/A* | No | | -r | Post reply-to tweets (ignored by default) | *N/A* | No | | -s | Skip retweets (posted by default) | *N/A* | No | +| -l | Remove link redirection | *N/A* | No | | -u | Remove trackers from URLs | *N/A* | No | | -a | Max. age of tweet to post (in days) | `5` | No | | -d | Min. age before posting new tweet (in minutes) | `15` | No | | -c | Max number of toots allowed to post (cap) | `1` | No | +## Notes + +`-l` will follow every link included in the tweet and replace them with the url that the +resource is directly dowmnloaded from (if applicable). e.g. bit.ly/xxyyyzz -> example.com +Every link visit can take up to 5 sec (timeout) therefore this option will slow down +tweet processing. + When using the `-v` switch consider: * whether the copyright of the content that you want to cross-post allows it @@ -64,7 +68,8 @@ Default min delay is 0 minutes. No limitation is applied to the number of toots uploaded if `-c` is not specified. -## installation + +## Installation Make sure python3 is installed.