Skip to content

Commit

Permalink
docs: update README.md (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
muktihari authored Jan 8, 2024
1 parent 09d1e76 commit c44820a
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,19 @@ However, despite having gained widespread adoption, Garmin has not yet released

More about FIT: [developer.garmin.com/fit](https://developer.garmin.com/fit)

This SDK is designed with efficiency in mind, but it places a higher priority on clarity, simplicity and extensibility.
This SDK is designed with efficiency in mind, but it places a higher priority on clarity, simplicity and extensibility. There might be some Go implementations out there for decoding or encoding FIT, but we offer greater completeness and similar semantics to the Official SDK.

## Usage

Please see [Usage](/docs/usage.md).

## Key distinct features

1. You have full control over the data since by default it uses FIT protocol messages semantic instead of direct mapping to user-defined struct. However, we still offer the user-defined struct mapping for someone who prefer to interact with FIT that way. See [Usage](/docs/usage.md) for details.
1. Receive the message as soon as it is decoded by registering listeners to the decoder. The decoder will broadcast every message to all registered listeners.
1. Decoding and Encoding **Developer Fields** since [Protocol Version 2.0 is supported](#Protocol-Version-2.0-is-supported)
1. Encoding **multiple local message type** and **compressed message** are supported, it means, you can create the smallest binary size as possible than just using localMesgNum 0.

## Protocol Version 2.0 is supported

Version 2.0 introduced [**Developer Fields**](https://developer.garmin.com/fit/cookbook/developer-data) as a way to add custom data fields to existing messages. We strives to support **Developer Fields** and carefully thought about how to implement it since the inception of the SDK. While this may still need to be battle-tested to ensure correctness, this is generally work and usable.
Expand Down

0 comments on commit c44820a

Please sign in to comment.