Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
lswiderski committed Jan 19, 2024
1 parent 8683ee5 commit f655ef3
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,40 @@
# yet-another-garmin-connect-client
# YAGCC
YAGCC: Yet Another Garmin Connect Client

# Docker-Compose Example
YAGCC is a:
- Library
- CLI client
- Selfhosted WEB API

using which you can create a .fit file with activity and upload it to Garmin Connect.

Currently it is at a very early stage. It only has the features that I needed for my other projects.

## Examples
YAGCC was created for and in my 2 other projects:
- Mi Scale Exporter https://github.com/lswiderski/mi-scale-exporter
- Web Body Composition https://github.com/lswiderski/WebBodyComposition


## Usage

![CLI](https://github.com/lswiderski/yet-another-garmin-connect-client/blob/main/resources/img/yagcc.png?raw=true)

![uploadbodycomposition](https://github.com/lswiderski/yet-another-garmin-connect-client/blob/main/resources/img/uploadbodycomposition.png?raw=true)

![uploadbloodpressure](https://github.com/lswiderski/yet-another-garmin-connect-client/blob/main/resources/img/uploadbloodpressure.png?raw=true)

![API](https://github.com/lswiderski/yet-another-garmin-connect-client/blob/main/resources/img/api.png?raw=true)

## Docker-Compose Example
```yaml
version: "3.9"

services:
yagcc-api:
yagcc-api:
container_name: YAGCC
restart: unless-stopped
image: lswiderski/yet-another-garmin-connect-client-api
ports:
- 80:80
```

0 comments on commit f655ef3

Please sign in to comment.