bitbot-3.11-fork/README.md

# BitBot
Python3 event-driven modular IRC bot!

## Dependencies
* [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4)
* [twitter](https://pypi.python.org/pypi/twitter)
* [scrypt](https://pypi.python.org/pypi/scrypt)

## Configurating
To get BitBot off the ground, there's some API-keys and the like in bot.json.example. move it to bot.json, fill in the API keys you want (and remove the modules that rely on those configs.)

## Running
Just run `./start.py`

On first boot, he'll ask for a first server to connect to then exit. do `./start.py` again and he'll connect to that server and join #bitbot (to get him to join other channels, simply invite him to them.)

## Data storage
The main data storage for Bitbot is done in his sqlite3 database, bot.db.
first commit. 2016-03-29 11:56:58 +00:00			`# BitBot`
			`Python3 event-driven modular IRC bot!`

			`## Dependencies`
added permissions.py which contains code for identifying/registering/logouting users. updated README.md to reflect the newly required scrypt module. 2016-04-04 17:42:37 +00:00			`* [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4)`
first commit. 2016-03-29 11:56:58 +00:00			`* [twitter](https://pypi.python.org/pypi/twitter)`
added permissions.py which contains code for identifying/registering/logouting users. updated README.md to reflect the newly required scrypt module. 2016-04-04 17:42:37 +00:00			`* [scrypt](https://pypi.python.org/pypi/scrypt)`
first commit. 2016-03-29 11:56:58 +00:00
			`## Configurating`
			`To get BitBot off the ground, there's some API-keys and the like in bot.json.example. move it to bot.json, fill in the API keys you want (and remove the modules that rely on those configs.)`

			`## Running`
			Just run `./start.py`

added a little more to README.md. 2016-03-29 13:40:56 +00:00			On first boot, he'll ask for a first server to connect to then exit. do `./start.py` again and he'll connect to that server and join #bitbot (to get him to join other channels, simply invite him to them.)
first commit. 2016-03-29 11:56:58 +00:00
			`## Data storage`
			`The main data storage for Bitbot is done in his sqlite3 database, bot.db.`