Merge branch 'hotfix/0.2.1'

[hubacji1/coffee-getter.git] / README.md

diff --git a/README.md b/README.md
index 4e5c14d39cdaf4f99edfeab34bd98af68151e7b9..0dd542104d1fcff55fd5dd0caeffc89d68748c2c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,6 +2,19 @@
 Somehow friendly API to get and share coffee related data from database.
 
 # Development
+## Database and Getter
+`cbdb` module is used as interface to database. When getting data from
+database, add methods here.
+
+Data got from database are processed in `cbgetter` module. Feel free to add
+formatting methods here. Also communication to slack is handled in this module.
+
+## Runnables
+Scripts to be run by systemd timers should by as simple as possible, runnable,
+python3 script file.
+
+There are no tests needed for runnables.
+
 ## Timers
 For running tasks periodically, please see [Timers][6] and [User][7] pages
 about systemd on archlinux wiki.
@@ -12,8 +25,8 @@ The example `top5_mate_stats.service`:
 Description=Run top 5 Mate drinkers stats
 
 [Service]
-Environment=PYTHONPATH=/path/to/coffee-getter/repo/
-ExecStart=/path/to/coffee-getter/repo/run/top5_mate_stats.py
+Environment=PYTHONPATH=/path/to/coffee-getter
+ExecStart=/path/to/coffee-getter/run/top5_mate_stats.py
 ```
 
 The example `top5_mate_stats.timer`: