mathdatech/twoot
1
0
Fork 0
mirror of https://gitlab.com/jeancf/twoot.git synced 2025-01-31 05:33:45 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

Added documentation of -v option to README.md

Browse Source
This commit is contained in:
jeancf 2020-03-28 11:33:38 +01:00
parent ba3da6ab7c
commit b1c9ec3811
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -20,11 +20,12 @@ of last week.
* Fetch timeline of given users from twitter.com * Fetch timeline of given users from twitter.com
* Scrape html and formats tweets for post on mastodon * Scrape html and formats tweets for post on mastodon
* Emojis supported * Emojis supported
* Upload images from tweet to Mastodon (videos not supported) * Optionally upload videos from tweet to Mastodon
* Upload images from tweet to Mastodon
* Specify maximum age of tweet to be considered * Specify maximum age of tweet to be considered
* Specify minimum delay before considering a tweet for upload * Specify minimum delay before considering a tweet for upload
* Remember tweets already tooted to prevent double posting * Remember tweets already tooted to prevent double posting
* Can optionally post reply-to tweets on the mastodon account * Optionally post reply-to tweets on the mastodon account
# usage # usage
@ -45,10 +46,16 @@ is @superduperbot@botsin.space
| -i | Mastodon instance domain name | `botsin.space` | Yes | | -i | Mastodon instance domain name | `botsin.space` | Yes |
| -m | Mastodon username | `superduperbot` | Yes | | -m | Mastodon username | `superduperbot` | Yes |
| -p | Mastodon password | `my_Sup3r-S4f3*pw` | 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 | | -r | Post reply-to tweets (ignored by default) | *N/A* | No |
| -a | Max. age of tweet to post (in days) | `1` | No | | -a | Max. age of tweet to post (in days) | `1` | No |
| -d | Min. delay before posting new tweet (in minutes) | `15` | No | | -d | Min. delay before posting new tweet (in minutes) | `15` | No |
When using the `-v` switch consider:
* The copyright of the content that you want to cross-post
* The storage / transfer limitations of the Mastodon instance that you are posting to
* The upstream bandwidth that you may consume on your internet connection
Default max age is 1 day. Decimal values are OK. Default max age is 1 day. Decimal values are OK.
Default min delay is 0 minutes. Default min delay is 0 minutes.