Modify readme

This commit is contained in:
VC
2020-03-02 07:13:41 +01:00
parent 75a099c412
commit f07f4e570a

View File

@@ -1,5 +1,12 @@
A Twitter to Mastodon copy bot written in Rust
It:
* copies the content (text) of the original Tweet
* dereferences the links
* gets every attach media (photo, video or gif)
If any of the last steps failed, the Toot gets published with the exact same text as the Tweet.
# Usage
First up, create a configuration file (default path is `/usr/local/etc/scootaloo.toml`). It will look like this:
@@ -56,5 +63,5 @@ SUBCOMMANDS:
# Quirks
As of now, its only able to copy text from a tweet to a toot. Call this a work in progress.
Scootaloo does not respect the spam limits imposed by Mastodon: it will make a 429 error if too much Tweets are converted to Toots in a short amount of time (and it will not recover from it). By default, it gets the last 200 tweets from the user timeline (which is a lot!). It is recommended to put a Tweet number into the `last_tweet` file before copying an old account.