Skip to content

Commit

Permalink
chore: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
panaaj committed Sep 29, 2024
1 parent a037b1c commit e4aaa11
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 @@ -2,7 +2,14 @@

Signal K Node server plugin to provide chart metadata, such as name, description and location of the actual chart tile data.

Supports both v1 and v2 Signal K resources api paths.
Chart metadata is derived from the following supported chart files:
- Mapbox Tiles _(.mbtiles)_
- Mapbox Style _(.json)_
- TMS _(tilemapresource.xml and tiles)_

Additionally chart metadata can be defined for other chart sources and types _(e.g. WMS, WMTS, S-57 tiles and tileJSON)_.

Chart metadata made available to both v1 and v2 Signal K resources api paths.

| Server Version | API | Path |
|--- |--- |--- |
Expand Down

0 comments on commit e4aaa11

Please sign in to comment.