updated the Readme

README.md

@@ -1,3 +1,22 @@
-# This is a project that monitors the progress of my assignment
+# Master Assignement Monitoring
+To monitor my progress of my master assignment I add daily tasks in [Todoist](https://www.todoist.com).
+The progress of the tasks is monitored with notes attached to that task.
+Via their API, the python script will currently check for:
+* Atleast 3 tasks planned for today.
+* If every closed task has notes attached to it.
+* How many tasks are over due.
+If one of the tasks fail it will send out a desktop notification.
+
+## Notification
+The notifications are send via a Gio-library for python:
+[GIO-2.0](https://lazka.github.io/pgi-docs/#Gio-2.0)
+
+
+## Systemd timer
+To run the check regularly.
+The python command is executed reqularly via a service.
+See the `systemd_timer_files`-directory for more information.
+
+## API-key
 There is no API-key in this repository, offcourse.
 You will have to add your own. The script tries to open the "apikey" file with the key in it.