Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xballoy committed Apr 19, 2024
1 parent 71bb603 commit 80b2420
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
File renamed without changes.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,25 @@ anytime.

- Install Node.js (see [.nvmrc](.nvmrc) for the supported version)
- Run `npm install`
- Run `npm start -- export-activities -u COROS_EMAIL_ID -p PASSWORD -o OUT_DIR`.
- Create a `.env` file (see [.env.example](.env.example)) with your email, password and the Coros API URL
- Run `npm start -- export-activities -out OUT_DIR`.

For example:
Example:

```shell
npm start -- export-activities -u [email protected] -p mysecurepassword -o ~/Dowloads
# Download all activities in fit format in Downloads folder
npm start -- export-activities -o ~/Dowloads
```

By default, the script will download the last 100 activities from your Coros profile. You can change this setting by
editing the `queryActivities` parameters in the [index.ts](src/index.ts.old).
**Options:**

```
-o, --out [outDir] Output directory
--exportType <fileType> Export data type (choices: "fit", "tcx", "gpx", "kml", "csv", default: "fit")
--fromDate <from> Export activities created after this date (inclusive). Format must be YYYY-MM-DD
--toDate <to> Export activities created before this date (inclusive). Format must be YYYY-MM-DD
-h, --help display help for command
```

## Licence

Expand Down

0 comments on commit 80b2420

Please sign in to comment.