Merge branch 'master' of github.com:cquest/tootbot

README.md

@@ -1,6 +1,6 @@
 # TootBot
 
-A small python script to replicate tweets on a mastodon account.
+A small python 3.x script to replicate tweets on a mastodon account.
 
 The script only need mastodon login/pass to post toots.
 
@@ -12,10 +12,31 @@ A sqlite database is used to keep track of tweets than have been tooted.
 
 
 This script is in use for a few accounts:
-- cq94 -> https://amicale.net/@cquest
+- cq94 -> https://amicale.net/@cquest (original author mastodon account)
 - Etalab -> https://mastodon.etalab.gouv.fr/@etalab
 - datagouvfr -> https://mastodon.etalab.gouv.fr/@datagouvfr
 - osm_fr -> https://fr.osm.social/@osm_fr
 - sotmfr -> https://fr.osm.social/@sotmfr
 
 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).
+
+## Setup
+
+```
+# clone this repo
+git clone https://github.com/cquest/tootbot.git
+cd tootbot
+
+# install required python modules
+pip3 install -r requirements.txt
+```
+
+## Useage
+
+`python3 tootbot.py <twitter_pseudo> <mastodon_account> <mastodon_password> <mastodon_domain>`
+
+Example:
+
+`python3 tootbot.py geonym_fr geonym@mastodon.mydomain.org **password** mastodon.mydomain.org`
+
+It's up to you to add this in your crontab :)

cron-sample.sh

@@ -7,5 +7,5 @@
 # 3- mastodon password
 # 4- instance domain (https:// is automatically added)
 
-python tootbot.py geonym_fr geonym@amicale.net **password** test.amicale.net
-python tootbot.py cq94 cquest@amicale.net **password** test.amicale.net
+python3 tootbot.py geonym_fr geonym@amicale.net **password** test.amicale.net
+python3 tootbot.py cq94 cquest@amicale.net **password** test.amicale.net