add sqlite database support

[erebus.git] / README.md

diff --git a/README.md b/README.md
index 2ec3dc8daca27732bd70bc7d2e5add576965a650..2e1a2d1e00b0dbd40d3ecd6e5b0e75cfba35b7d0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,9 +5,17 @@ Getting started
 ---------------
 - `cp bot.config.example bot.config`
 - `vim bot.config`
-- Create a MySQL database, i.e. `CREATE DATABASE foo; GRANT ALL ON foo.* TO ...`
-- `mysql <dump.sql`
-- Add your auth (main NickServ nick/account name on other networks) in the database as owner: `INSERT INTO users VALUES ('YourAuth', 100);`
+- Pick a database:
+  - MySQL:
+    - Create a MySQL database, i.e. `CREATE DATABASE foo; GRANT ALL ON foo.* TO ...`
+    - `mysql <mysql.sql`
+    - dbtype=mysql, dbhost/dbuser/dbpass/dbname with connection info
+  - SQLite
+    - `sqlite3 erebus.db <sqlite.sql`
+    - dbtype=sqlite, dbhost=erebus.db (or other database path)
+- Populate at least the `bots` and `users` table:
+  - Add a bot: `INSERT INTO bots VALUES ('nick', 'user', NULL, NULL, NULL, 1, 0)`
+  - Add your auth (main NickServ nick/account name on other networks) in the database as owner: `INSERT INTO users VALUES ('YourAuth', 100);`
 - `./run`
 
 Install croncheck.sh in your crontab, if desired.