Update README.md

2026-03-31 09:52:05 +01:00
parent 0441408bf7
commit 6b97b3ce19
1 changed files with 22 additions and 0 deletions
@@ -1,2 +1,24 @@
 # Garmin-API

+# Setup
+Create a folder for the container and files
+```
+mkdir garmin
+```
+
+Copy the docker compose file and create a .env file with your details,
+```
+GARMIN_EMAIL=
+GARMIN_PASSWORD=
+START_DATE=2026-01-01
+GOAL_KM=100
+ALLOWED_TYPES=running,treadmill_running,walking
+CACHE_TTL=300 # Limit login attempts
+TEST_MODE=false # Create fake data for testing without hitting garmin api
+```
+
+An image can be added by cloning the repo, dropping a logo.png file into the root directory and running convert_image.py
+```
+python3 convert_image.py
+```
+This will drop the logo.bin file into data. You can copy this into your data folder volume mount.