merged the two READMEs

README

@@ -1,13 +0,0 @@
-INSTALL
-=======
-
-Install python3 with your favourite package manager.
-Create and activate virtualenv
-```shell
-$ virtualenv -p python3 .
-$ . bin/activate
-```
-Install dependencies
-```shell
-$ pip3 install Mastodon.py
-```

README.md

@@ -0,0 +1,53 @@
+# Ticketfrei micro messaging bot
+
+<!-- This mastodon/twitter bot has one purpose - breaking the law. -->
+
+The functionality is simple: it retweets every tweet where it is mentioned.
+
+This leads to a community which evolves around it; if you see ticket controllers, you tweet their location and mention the bot. The bot then retweets your tweet and others can read the info and think twice if they want to buy a ticket. If enough people, a critical mass, participate for the bot to become reliable, you have positive self-reinforcing dynamics.
+
+There is one security hole: people could start mentioning the bot with useless information, turning it into a spammer. That's why it has to be maintained; if someone spams the bot, mute them and undo the retweet. So it won't retweet their future tweets and the useless retweet is deleted if someone tries to check if something was retweeted in the last hour or something.
+
+
+# Install
+
+Install python3 with your favourite package manager.
+Create and activate virtualenv
+```shell
+$ virtualenv -p python3 .
+$ . bin/activate
+```
+Install dependencies
+```shell
+$ pip3 install Mastodon.py
+```
+
+## ideas
+
+* You can only use the twitter API if you have confirmed a phone number and sacrificed a penguin in a blood ritual. So we should build it in a way that it uses the twitter web GUI. It's difficult, but maybe it works. We had another twitter bot that worked similarly, years ago: https://github.com/b3yond/twitter-bot
+* Make it for mastodon instead of twitter. Mastodon has an open API, that's way more fun. Also mastodon may profit from the network effects though it may be hard to reach the critical mass if you can only use mastodon users. 
+* Bridge to mastodon, so people can use both platforms. Easier to reach the critical mass. But could be hard to do without the twitter API.
+* Build a tool that deletes wrong toots/tweets on both platforms, would work nicely with a web UI.
+* write the muted people to the db, to easily undo the mutes if necessary.
+
+## research
+
+- [x] How to crawl mentions with the mastodon API
+- [x] How to boost people with the mastodon API
+- [x] How to access the twitter API
+- [ ] How to crawl mentions with the twitter API
+- [ ] How to retweet people with the twitter API
+
+## to do
+
+- [ ] Twitter: Crawl mentions
+- [ ] Mastodon: Crawl mentions
+- [ ] Write toots/tweets to database
+- [ ] Twitter: retweet people
+- [ ] Mastodon: boost people
+- [ ] Mastodon: toot who has been retweeted on twitter
+- [ ] Twitter: tweet who has been boosted on mastodon
+- [ ] Twitter: access the API
+- [ ] Web UI that lets you easily delete toots/tweets per db id and mute the tweet author
+
+