docs(README): Add screenshots for version 2.0.1 and 2.0.2

Included screenshots in the README to illustrate the application running in different environments. This enhances user understanding of the application setup and usage. Updated the file structure to reflect the new versioning and added notes on running the application with Docker and standard Python.
EvickaStudio · Mar 3, 2025 · c6c7e7d · c6c7e7d
1 parent 61ebfe6
commit c6c7e7d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -170,6 +170,22 @@ When running, the application will:
 3. Continuously monitor for new notifications.
 4. Process and deliver notifications according to your settings.
 
+## Screenshots
+
+*Colors between the screenshots are different because of different themes in Termius.*
+
+### v2.0.2 (Docker)
+
+![v2.0.2](assets/running_v2.0.2.png)
+
+Running as Docker deamon, to see the logs run `docker compose logs -f`
+
+### v2.0.1
+
+![v2.0.1](assets/running_v2.0.1.webp)
+
+Running as standard python application, you will automatically see the logs in the terminal you ran the command in. For KVMs running MoodleMate in the background, docker is the recommended way to run it, but you can also use tmux, screen or tmuxinator to run it in the background.
+
 ## Creating Custom Notification Providers
 
 MoodleMate now supports a plugin system that allows you to easily create and add your own notification providers without modifying the core code.

diff --git a/assets/running.webp → assets/running_v2.0.1.webp b/assets/running.webp → assets/running_v2.0.1.webp
diff --git a/assets/running_v2.0.2.png b/assets/running_v2.0.2.png