From 01174b1cf0cad00d05c8a8d758692f6ac979fd4d Mon Sep 17 00:00:00 2001
From: cquest <cquest@openstreetmap.fr>
Date: Mon, 29 May 2017 23:03:17 +0200
Subject: [PATCH] first README

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd061d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# TootBot
+
+A small python script to replicate tweets on a mastodon account.
+
+The script only need mastodon login/pass to post toots.
+
+It gets the tweets from RSS available at http://twitrss.me, then does some cleanup on the content:
+- twitter tracking links (t.co) are dereferenced
+- twitter hosted pictures are retrieved and uploaded to mastodon
+
+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
+- 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).
-- 
GitLab