Update README.md, move default sqlite to database folder (#21)

.gitignore

@@ -12,4 +12,6 @@ pytest.xml
 coverage.xml
 
 backups/
+database/
+
 *.db

README.md

@@ -17,9 +17,9 @@ The data is crawled from the official steam web api (https://steamcommunity.com/
 ## Features
 
 * Get the latest news & updates about Counter Strike 2
-* General Spam protection (chat based)
-* Option command to retrieve only news or updates posts
-* Data is crawled from the official website and checked every 15 minutes
+* General spam protection (chat based)
+* Option command to retrieve only interested posts about news, updates or external news
+* Data is crawled from the official steam api and checked every few minutes (default: 15 minutes)
 
 
 ## Usage
@@ -45,7 +45,7 @@ To use [@CS2PostsBot](https://t.me/CS2PostsBot), simply start a chat with the bo
 
 ### Adding the Bot to a Group
 
-Adding the bot to a group is possible. The person adding the bot to the group will be the admin of the bot. Which means only the admin can use the `/options` command to enable / disable news, updates or external news posts for the group chat.
+Adding the bot to a group is possible. The person who adds the bot to the group will be the admin of the bot. Which means only the admin can use the `/options` command to enable / disable news, updates or external news posts for the group chat.
 
 To prevent spamming a spam protection is implemented. After 3 (default) strikes the chat will be banned and receives a timeout. This affects the whole chat not only the user who spammed.
 
@@ -73,11 +73,13 @@ Possible environment variables:
 for detailed information see `cs2posts/bot/settings.py`.
 
 
-Create a docker image and run the bot. From the root folder exeucte the following commands:
+Create a docker image and run the bot. From the root folder execute the following commands:
 
 ```bash
-docker build -t cs2-posts-bot .
-docker run -d -v cs2posts/data:/app/cs2posts/data --env-file .env --name cs2-posts-bot cs2-posts-bot
+mkdir backups
+mkdir database
+docker build -t cs2-news-bot .
+docker run -d -v backups:/app/backups/ -v database:/app/database --env-file .env --name cs2-news-bot cs2-news-bot
 ```
 
 To start the cron job checking for news & updates write `/start` in the chat of your bot.

cs2posts/bot/settings.py

@@ -12,7 +12,7 @@
 TELEGRAM_TOKEN = os.getenv('TELEGRAM_TOKEN')
 CS2_UPDATE_CHECK_INTERVAL = int(os.getenv('CS2_UPDATE_CHECK_INTERVAL', 900))
 
-# Database filepaths (default: sqlite.db for both if None)
+# Database filepaths (default: database/sqlite.db for both if None)
 CHAT_DB_FILEPATH = os.getenv('CHAT_DB_FILEPATH', None)
 POST_DB_FILEPATH = os.getenv('POST_DB_FILEPATH', None)
 

cs2posts/db.py

@@ -49,7 +49,9 @@ class SQLite(Database):
 
     def __init__(self, filepath: Path | None) -> None:
         if filepath is None:
-            filepath = Path(__file__).parent.parent / "sqlite.db"
+            filepath = Path(__file__).parent.parent / "database"
+            filepath.mkdir(parents=True, exist_ok=True)
+            filepath /= "sqlite.db"
 
         super().__init__(filepath)