1 files changed, 141 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..365f9c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,141 @@
+fit2mf2
+=======
+
+A utility to convert a Garmin FIT data file into a microformat entry.
+
+
+Usage
+-----
+
+    Usage: fit2mf2 [OPTIONS] [FILE]
+
+    Arguments:
+      [FILE]  FIT file to convert. If no file is given, reads from stdin.
+
+    Options:
+      -t, --category <CATEGORY>       Category to add to the entry.
+                                      May be given more than once.
+
+          --hide <lat,long,radius>    Location to mask in output. Radius in
+                                      meters. May be given more than once.
+
+      -h, --help
+
+
+Sample output
+-------------
+
+    {
+      "type": [
+        "h-entry"
+      ]
+      "properties": {
+        "activity": [
+          {
+            "sport": "running",
+            "start": "2021-06-19T14:51:50Z",
+            "start_position": "geo:47.6264,-122.3371",
+            "end_position": "geo:47.6264,-122.3371",
+            "max_heart_rate": {
+              "num": 195.0,
+              "unit": "bpm"
+            },
+            "max_speed": {
+              "num": 3.76,
+              "unit": "m/s"
+            },
+            "timer": {
+              "num": 3742.613,
+              "unit": "s"
+            },
+            "ascent": {
+              "num": 115.0,
+              "unit": "m"
+            },
+            "avg_heart_rate": {
+              "num": 169.0,
+              "unit": "bpm"
+            },
+            "avg_speed": {
+              "num": 2.7,
+              "unit": "m/s"
+            },
+            "calories": {
+              "num": 691.0,
+              "unit": "kcal"
+            },
+            "descent": {
+              "num": 171.0,
+              "unit": "m"
+            },
+            "distance": {
+              "num": 10104.88,
+              "unit": "m"
+            },
+            "duration": {
+              "num": 3742.613,
+              "unit": "s"
+            },
+            "laps": [
+              {
+                "sport": "running",
+                "start": "2021-06-19T14:51:50Z",
+                "start_position": "geo:47.6264,-122.3371",
+                "end_position": "geo:47.6336,-122.3401",
+                "ascent": {
+                  "num": 7.0,
+                  "unit": "m"
+                },
+                "avg_heart_rate": {
+                  "num": 144.0,
+                  "unit": "bpm"
+                },
+                "avg_speed": {
+                  "num": 2.876,
+                  "unit": "m/s"
+                },
+                "calories": {
+                  "num": 53.0,
+                  "unit": "kcal"
+                },
+                "descent": {
+                  "num": 2.0,
+                  "unit": "m"
+                },
+                "distance": {
+                  "num": 1000.0,
+                  "unit": "m"
+                },
+                "duration": {
+                  "num": 347.712,
+                  "unit": "s"
+                },
+                "max_heart_rate": {
+                  "num": 177.0,
+                  "unit": "bpm"
+                },
+                "max_speed": {
+                  "num": 3.602,
+                  "unit": "m/s"
+                },
+                "timer": {
+                  "num": 347.712,
+                  "unit": "s"
+                }
+              },
+              ...
+            ]
+          }
+        ],
+        "location": [
+          "geo:47.6264,-122.3371"
+        ],
+        "published": "2021-06-19T14:51:50Z"
+      },
+    }
+
+Contributing
+------------
+
+Send questions, bug reports, and patches to jesse@jesterpm.net.
+