@geoql/v-maplibre 1.7.1 → 1.8.1

package/README.md

@@ -22,40 +22,63 @@
 
 ## Installation
 
+The library has **two required dependencies**. Everything else is opt-in per feature.
+
 ```bash
-# bun
-bun add @geoql/v-maplibre maplibre-gl @deck.gl/{core,layers,mapbox,aggregation-layers,geo-layers,mesh-layers} maplibre-gl-wind
+# pnpm (recommended)
+pnpm add @geoql/v-maplibre maplibre-gl
 
 # npm
-npm install @geoql/v-maplibre maplibre-gl @deck.gl/{core,layers,mapbox,aggregation-layers,geo-layers,mesh-layers} maplibre-gl-wind
+npm install @geoql/v-maplibre maplibre-gl
 
 # yarn
-yarn add @geoql/v-maplibre maplibre-gl @deck.gl/{core,layers,mapbox,aggregation-layers,geo-layers,mesh-layers} maplibre-gl-wind
-
-# pnpm
-pnpm add @geoql/v-maplibre maplibre-gl @deck.gl/{core,layers,mapbox,aggregation-layers,geo-layers,mesh-layers} maplibre-gl-wind
+yarn add @geoql/v-maplibre maplibre-gl
 ```
 
-> **Note:** All packages listed above are required peer dependencies. Without them, your build will fail with missing export errors.
+That covers `VMap`, `VMarker`, `VPopup`, all controls (`VControl*`), and every MapLibre-native layer (`VLayerMaplibre*`).
 
-### Additional Optional Dependencies
+### Optional peer dependencies
 
-Install these packages based on the features you need:
+Add these **only** for the layers you actually use — picking what you need keeps your bundle lean:
 
 ```bash
-# Raster/COG layers (Cloud-Optimized GeoTIFF)
-bun add @developmentseed/deck.gl-raster @developmentseed/deck.gl-geotiff @developmentseed/geotiff
+# deck.gl base — VLayerDeckgl, VLayerDeckglScatterplot, VLayerDeckglArc,
+# VLayerDeckglLine, VLayerDeckglPath, VLayerDeckglPolygon, VLayerDeckglSolidPolygon,
+# VLayerDeckglGeojson, VLayerDeckglIcon, VLayerDeckglText, VLayerDeckglColumn,
+# VLayerDeckglBitmap, VLayerDeckglPointCloud
+pnpm add @deck.gl/core @deck.gl/layers @deck.gl/mapbox
+
+# Aggregation — VLayerDeckglHeatmap, VLayerDeckglHexagon, VLayerDeckglGrid,
+# VLayerDeckglGridCell, VLayerDeckglContour, VLayerDeckglScreenGrid
+pnpm add @deck.gl/aggregation-layers
+
+# Geo / tiles — VLayerDeckglTrips, VLayerDeckglMVT, VLayerDeckglTile,
+# VLayerDeckglTile3D, VLayerDeckglTerrain, VLayerDeckglH3Hexagon,
+# VLayerDeckglH3Cluster, VLayerDeckglS2, VLayerDeckglGeohash,
+# VLayerDeckglQuadkey, VLayerDeckglGreatCircle, VLayerDeckglWMS
+pnpm add @deck.gl/geo-layers
 
-# COG Mosaic layers (client-side mosaicking of multiple COGs)
-bun add @developmentseed/deck.gl-raster @developmentseed/deck.gl-geotiff @developmentseed/geotiff
+# 3D mesh — VLayerDeckglSimpleMesh, VLayerDeckglScenegraph
+pnpm add @deck.gl/mesh-layers
 
-# LiDAR viewer control
-bun add maplibre-gl-lidar
+# Cloud-Optimized GeoTIFF — VLayerDeckglCOG, VLayerDeckglMultiCOG, VLayerDeckglMosaic
+pnpm add @developmentseed/deck.gl-geotiff @developmentseed/deck.gl-raster @developmentseed/geotiff @developmentseed/proj
 
-# Wind particle visualization
-bun add maplibre-gl-wind
+# Zarr — VLayerDeckglZarr
+pnpm add @developmentseed/deck.gl-zarr zarrita
+
+# Wind particles — VLayerDeckglWindParticle
+pnpm add maplibre-gl-wind
+
+# LiDAR point cloud viewer — VControlLidar
+pnpm add maplibre-gl-lidar
+
+# Three.js starfield skybox for globe projections — VLayerMaplibreStarfield
+pnpm add @geoql/maplibre-gl-starfield three
 ```
 
+If you import a layer without its peer deps installed, your bundler will surface a `Cannot find module '...'` error — install the missing package(s) from the table above to resolve it.
+
 ## Quick Start
 
 ```vue
@@ -73,7 +96,7 @@ bun add maplibre-gl-wind
 
 <template>
   <VMap :options="mapOptions" style="height: 500px">
-    <VMarker :lng-lat="[-74.5, 40]"></VMarker>
+    <VMarker :coordinates="[-74.5, 40]"></VMarker>
   </VMap>
 </template>
 ```
@@ -297,16 +320,16 @@ This package is part of the [v-maplibre monorepo](https://github.com/geoql/v-map
 # Clone and install (from monorepo root)
 git clone https://github.com/geoql/v-maplibre.git
 cd v-maplibre
-bun install
+pnpm install
 
 # Build this package
-bun run --cwd packages/v-maplibre build
+pnpm --filter @geoql/v-maplibre run build
 
 # Run tests
-bun run test
+pnpm run test
 
 # Watch mode
-bun run dev:lib
+pnpm run dev:lib
 ```
 
 ## License