docs: update docs

hkfb · Jan 7, 2025 · defb08d · defb08d
1 parent ed86860
commit defb08d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![codecov](https://codecov.io/github/hkfb/velo.gl/graph/badge.svg?token=51M41YJFGO)](https://codecov.io/github/hkfb/velo.gl)
 
-Library for interactive 3D visualization of GPX activities.
+React/Typescript library for interactive 3D visualization of GPX and TCX activities.
 
 ![GpxLayer](https://github.com/hkfb/velo.gl/raw/main/sample/velo.gl.webp)
 

diff --git a/package.json b/package.json
@@ -1,9 +1,12 @@
 {
     "name": "velo.gl",
+    "description": "React/Typescript library for interactive 3D visualization of GPX and TCX activities.",
+    "repository": "github:hkfb/velo.gl",
     "author": "Håvard Bjerke",
     "license": "MIT",
     "keywords": [
         "gpx",
+        "tcx",
         "webgl",
         "visualization",
         "react",

diff --git a/src/layers/README.md b/src/layers/README.md
@@ -28,7 +28,7 @@ const MyActivityMap = () => {
 };
 ```
 
-See also [Story](https://hkfb.github.io/velo.gl/?path=/docs/layers-activity-layer--docs)
+See also [Activity Layer Story](https://hkfb.github.io/velo.gl/?path=/docs/layers-activity-layer--docs)
 
 ## Profile Layer
 Renders paths extruded vertically from sea level, from a set of 3D polylines.
@@ -38,3 +38,5 @@ Renders the position along a GPX trace at a given time.
 
 ## Extruded Path Layer
 Extends the [Deck.gl Path Layer](https://deck.gl/docs/api-reference/layers/path-layer) with vertical extrusion of paths.
+
+See also [Extruded Path Layer Story](https://hkfb.github.io/velo.gl/?path=/docs/layers-extruded-path-layer--docs)