Browse Source

Change README

Lertsenem 4 years ago
parent
commit
5cabbe7c6e
1 changed files with 14 additions and 13 deletions
  1. 14 13
      README.md

+ 14 - 13
README.md

@@ -1,21 +1,22 @@
1
-# TootBot
1
+# Birdlink Bot
2 2
 
3
-A small python script to replicate tweets on a mastodon account.
3
+A small python script to replicate tweets on a mastodon instance.
4 4
 
5
-The script only need mastodon login/pass to post toots.
5
+Use the 'add' command to add a new account to mirror. The account must exist
6
+with the same handle on twitter and on the Mastodon instance. The password for
7
+the account will be asked.
6 8
 
7
-It gets the tweets from RSS available at http://twitrss.me, then does some cleanup on the content:
9
+Use the 'run' command to check all mirrored accounts and post new tweets on the
10
+Mastodon instance.
11
+
12
+It gets the tweets from RSS available at http://twitrss.me, then does some
13
+cleanup on the content:
8 14
 - twitter tracking links (t.co) are dereferenced
9 15
 - twitter hosted pictures are retrieved and uploaded to mastodon
10 16
 
11
-A sqlite database is used to keep track of tweets than have been tooted.
12
-
17
+A json file is used to keep track of tweets than have been tooted.
13 18
 
14
-This script is in use for a few accounts:
15
-- cq94 -> https://amicale.net/@cquest
16
-- Etalab -> https://mastodon.etalab.gouv.fr/@etalab
17
-- datagouvfr -> https://mastodon.etalab.gouv.fr/@datagouvfr
18
-- osm_fr -> https://fr.osm.social/@osm_fr
19
-- sotmfr -> https://fr.osm.social/@sotmfr
19
+This script should be in use for the https://birdsite.link instance
20 20
 
21
-The script is simply called by a cron job and can run on any server (does not have to be on the mastodon instance server).
21
+The script is simply called by a cron job and can run on any server (does not
22
+have to be on the mastodon instance server).