Updated README and CHANGELOG

This commit is contained in:
jeancf 2023-07-11 21:10:39 +02:00
parent 7528afaff9
commit f64b92d175
2 changed files with 27 additions and 3 deletions

View File

@ -1,5 +1,11 @@
# Changelog
**28 JUN 2023** VERSION 4.0
* Added option to update avatar and banner pictures on profile if changed on Twitter
* Tweaked list of nitter instances
* Updated list of user agents
**13 MAR 2023** VERSION 3.2.2 Updated list of nitter instances
**21 FEB 2023** VERSION 3.2.1 Updated user agents and list of nitter instances

View File

@ -3,11 +3,13 @@
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.
**28 JUN 2023** VERSION 4.0
**11 JUL 2023** VERSION 4.1
* Added option to update avatar and banner pictures on profile if changed on Twitter
**A new dependency to python module `pytz` has been added**. Please run `pip install pytz`
in your environment to install it.
* Added option to add timestamp of the original tweet to toot
* Tweaked list of nitter instances
* Updated list of user agents
> Previous updates can be found in CHANGELOG.
@ -28,6 +30,7 @@ It is simple to set-up on a local machine, configurable and feature-rich.
* Optionally remove trackers (UTM parameters) from URLs
* Optional domain substitution for Twitter, Youtube and Reddit domains (e.g. [Nitter](https://github.com/zedeus/nitter/wiki/Instances),
[Invidious](https://redirect.invidious.io/) and [teddit](https://teddit.net/) respectively)
* option to add timestamp of the original tweet to bottom of toot
* Optional footer line to add tags at bottom of toot
* Allows rate-limiting posts to Mastodon instance
@ -101,6 +104,21 @@ have changed on the twitter page. This check compares the name of files used by
of the files that have been uploaded on Mastodon and if they differ both files are downloaded from
twitter and uploaded on Mastodon. The check is very fast if there is no update.
### Adding timestamp of original tweet to toot
Use `tweet_time_format` option in configuration file to specify the datetime format to display the date
at which the tweet was published next to the "Original tweet" link. Valid format specifiers are
the same as those used to format datetimes in python
(https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior).
e.g. `tweet_time_format = "(%d %b %Y %H:%M %Z)"`
An empty or missing `tweet_time_format` disables the display of the timestamp.
By default, dates are specified in UTC time zone. To convert the timestamp to another time zone,
use the `tweet_timezone` option in configuration file. Valid time zone names are those of the Olson time
zone database (https://en.wikipedia.org/wiki/Tz_database)
e.g. `tweet_timezone = "Europe/Paris"`
### Rate control
Default max age is 1 day. Decimal values are OK.