From 352c863db91d0f5d8c933f5759fc0f67636c2661 Mon Sep 17 00:00:00 2001 From: Michal Laskowski Date: Thu, 25 Feb 2021 20:55:05 +0100 Subject: [PATCH] Update readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index b415ca6..c1a0f00 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,17 @@ ## About the project A common interface for (currently) two decoders: + * zwo files (xml format) * fit files (binary format) that allow to create a common model of a workout. See `Sources/WorkoutDecoderBase/WorkoutDecoding.swift` for model definitions. +Models are easy to use: + +* intervals are flattened +* messages' time offset are normalized with respect to the beginning of the training + ### Built with * [FitFileParser](https://github.com/roznet/FitFileParser) @@ -37,6 +43,7 @@ do { ## Roadmap 1. Need to add a test for FIT file decoding. Will need to find a file that I can publish, or find a tool to create one. +2. Potential support for FIT notes as messages. For an app I am developing, ZWO and FIT file support is enough. MRC, ERG or other file support could be added if needed, but preferably by providing a PR :) Workout model could be extended if there is also a need for that.