From ada26687a88c2f3920eae81621b0dfb59e851814 Mon Sep 17 00:00:00 2001 From: gouravkr Date: Mon, 10 Jan 2022 07:51:31 +0530 Subject: [PATCH] Modified readme for sqlite support --- .env.sample | 2 +- readme.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.env.sample b/.env.sample index fa412e3..acfef14 100644 --- a/.env.sample +++ b/.env.sample @@ -5,7 +5,7 @@ DB_USER=abcd DB_PWD="abcd!#$" DB_HOST=localhost DB_PORT=5432 -DB_FILE="sample.sqlite" +DB_FILE="wordbot.sqlite" # Keys WORDBOT_TOKEN=0000000000:abcdefghij_kl_mn-op_qrst \ No newline at end of file diff --git a/readme.md b/readme.md index 4128ec1..f2cecac 100644 --- a/readme.md +++ b/readme.md @@ -11,6 +11,12 @@ This bot helps you learn new words for your GRE/GMAT preparations. All you have 6. Install all the addons from requirements.txt 7. Start the bot with the command `python word_bot.py` +### Database +Postgres and Sqlite databases are supported by the script natively. The included sqlite database will work out of the box. For connecting to sqlite, only the database file name is required, which is already provided in the .env.sample file. Hence, no changes to the database section will be required for sqlite. + +If you wish to use PostgreSQL database, change the value of the DATABASE key in the .env file to `postgres`. Make sure you also populate the rest of the values for the database. In case of postgres, the DB_FILE variable will be ignored. + + Have fun learning random words! ### To-do