From f943d63098a50746f4e470e403a991a4d9713030 Mon Sep 17 00:00:00 2001
From: jesopo
Date: Tue, 29 Mar 2016 12:56:58 +0100
Subject: first commit.

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..da655ef5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# BitBot
+Python3 event-driven modular IRC bot!
+
+## Dependencies
+* [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4/4.3.2)
+* [twitter](https://pypi.python.org/pypi/twitter)
+
+## 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, it'll ask for a first server to connect to then exit. do `./start.py` again and it'll connect to that server and join #bitbot.
+
+## Data storage
+The main data storage for Bitbot is done in his sqlite3 database, bot.db.
-- 
cgit v1.3.1-10-gc9f91