first commit

README.md

@@ -0,0 +1,59 @@
+### Feed2toot
+
+Feed2toot automatically parses rss feeds, identifies new posts and posts them on Twitter.
+For the full documentation, [read it online](https://feed2toot.readthedocs.org/en/latest/).
+
+If you would like, you can [support the development of this project on Liberapay](https://liberapay.com/carlchenet/).
+Alternatively you can donate cryptocurrencies:
+
+- BTC: 1BcdXCcLKN9PRpp6qw23FYkYuVp59dKZix
+- XMR: 4Cxwvw9V6yUehv832FWPTF7FSVuWjuBarFd17QP163uxMaFyoqwmDf1aiRtS5jWgCiRsi73yqedNJJ6V1La2joznUDzkmvBr6KKHT7Dvzj
+
+### Quick Install
+
+* Install Feed2toot from PyPI
+
+        # pip3 install feed2toot
+
+* Install Feed2toot from sources
+  *(see the installation guide for full details)
+  [Installation Guide](http://feed2toot.readthedocs.org/en/latest/install.html)*
+
+
+        # tar zxvf feed2toot-0.1.tar.gz
+        # cd feed2toot
+        # python3 setup.py install
+        # # or
+        # python3 setup.py install --install-scripts=/usr/bin
+
+### Use Feed2toot
+
+* Create or modify feed2toot.ini file in order to configure feed2toot:
+
+        [mastodon]
+        user_credentials=feed2toot_usercred.txt
+        client_credentials=feed2toot_clientcred.txt
+
+        [cache]
+        cachefile=cache.db
+
+        [rss]
+        uri=https://www.journalduhacker.net/rss
+        tweet={title} {link}
+
+        [hashtaglist]
+        several_words_hashtags_list=hashtags.txt
+
+* Launch Feed2toot
+
+        $ feed2toot -c /path/to/feed2toot.ini
+
+### Authors
+
+* Carl Chenet <chaica@ohmytux.com>
+* Antoine Beaupré <anarcat@debian.org>
+* First developed by Todd Eddy
+
+### License
+
+This software comes under the terms of the GPLv3+. Previously under MIT license. See the LICENSE file for the complete text of the license.