diff --git a/README.md b/README.md index 1021b62..4239167 100755 --- a/README.md +++ b/README.md @@ -6,9 +6,24 @@ Run the bot with the command `python bot.py`. The above command runs the bot, loops it every 60 seconds, makes fresh database connections every 300 seconds and only says it's stil running after 15 loops. You can edit the default values, just use `python bot.py --help` to see all options. +## Requirements + +Requires you install mysql-connector and Tweepy. + +Download mysql-connecter from here: https://dev.mysql.com/downloads/connector/python/ + +If you're using this on a RPi then you'll likely want the architecture independant .deb file. + +You can install Tweepy using pip, easy_install or any other method that gets it's pacages from PyPy: + +`pip install tweepy` + ##Setup + Edit the "configuration.py" file and enter your database credentials then run the setup script with `python setup.py`. +It will promt you to enter your Twitter credentials - Consumer Key & Secret, Access Token & Secret + ##Scheduling Tweets Add some scheduled tweets by calling the "add.py" script.