From 067347cebb51abf768362d1c07efa7aadd082e1e Mon Sep 17 00:00:00 2001
From: Brandon Liu <bdon@users.noreply.github.com>
Date: Fri, 2 Feb 2024 17:54:46 +0800
Subject: [PATCH] JS v3.0.0 (#346)

---
 js/README.md                         | 20 ++++++++++++--------
 js/examples/leaflet.html             |  2 +-
 js/examples/maplibre.html            |  2 +-
 js/examples/maplibre_raster_dem.html |  2 +-
 js/package-lock.json                 |  4 ++--
 js/package.json                      |  2 +-
 6 files changed, 18 insertions(+), 14 deletions(-)

diff --git a/js/README.md b/js/README.md
index 0519865..13c2a39 100644
--- a/js/README.md
+++ b/js/README.md
@@ -4,21 +4,24 @@ the [PMTiles](https://www.npmjs.com/package/pmtiles) package can be included via
 
 ```html
  <script src="https://unpkg.com/pmtiles@2.5.0/dist/index.js"></script>
- ```
+```
 
- As an ES6 module: `npm add pmtiles`
+All the PMTiles exports are available under the global `pmtiles` variable e.g. `pmtiles.PMTiles`.
 
- ```js
- import * as pmtiles from "pmtiles";
- ```
+As an ES6 module: `npm add pmtiles`
+
+```js
+import { PMTiles } from "pmtiles";
+```
 
 ### Leaflet: Raster tileset
 
 Example of a raster PMTiles archive displayed in Leaflet:
 
 ```js
-const p = new pmtiles.PMTiles('example.pmtiles')
-pmtiles.leafletRasterLayer(p,{attribution:'© <a href="https://openstreetmap.org">OpenStreetMap</a>'}).addTo(map)
+import { PMTiles, leafletRasterLayer } from "pmtiles";
+const p = new PMTiles('example.pmtiles')
+leafletRasterLayer(p,{attribution:'© <a href="https://openstreetmap.org">OpenStreetMap</a>'}).addTo(map)
 ````
 
 [Live example](https://protomaps.github.io/PMTiles/examples/leaflet.html) | [Code](https://github.com/protomaps/PMTiles/blob/main/js/examples/leaflet.html)
@@ -32,7 +35,8 @@ See [protomaps-leaflet](https://github.com/protomaps/protomaps-leaflet)
 Example of a PMTiles archive displayed in MapLibre GL JS:
 
 ```js
-let protocol = new pmtiles.Protocol();
+ import { Protocol } from "pmtiles";
+let protocol = new Protocol();
 maplibregl.addProtocol("pmtiles",protocol.tile);
 var style = {
 "version": 8,
diff --git a/js/examples/leaflet.html b/js/examples/leaflet.html
index b00f3f4..3560eb2 100644
--- a/js/examples/leaflet.html
+++ b/js/examples/leaflet.html
@@ -4,7 +4,7 @@
         <meta charset="utf-8"/>
         <link rel="stylesheet" href="https://unpkg.com/leaflet@1.7.1/dist/leaflet.css" />
         <script src="https://unpkg.com/leaflet@1.9.0/dist/leaflet.js"></script>
-        <script src="https://unpkg.com/pmtiles@3.0.0-alpha.2/dist/index.js"></script>
+        <script src="https://unpkg.com/pmtiles@3.0.0/dist/index.js"></script>
         <style>
             body, #map {
                 height:100vh;
diff --git a/js/examples/maplibre.html b/js/examples/maplibre.html
index c65975a..e95c6ea 100644
--- a/js/examples/maplibre.html
+++ b/js/examples/maplibre.html
@@ -4,7 +4,7 @@
         <meta charset="utf-8"/>
         <link rel="stylesheet" href="https://unpkg.com/maplibre-gl@3.3.1/dist/maplibre-gl.css" crossorigin="anonymous">
         <script src="https://unpkg.com/maplibre-gl@3.3.1/dist/maplibre-gl.js" crossorigin="anonymous"></script>
-        <script src="https://unpkg.com/pmtiles@3.0.0-alpha.2/dist/index.js"></script>
+        <script src="https://unpkg.com/pmtiles@3.0.0/dist/index.js"></script>
         <style>
             body {
                 margin: 0;
diff --git a/js/examples/maplibre_raster_dem.html b/js/examples/maplibre_raster_dem.html
index 01f732f..d6d62e6 100644
--- a/js/examples/maplibre_raster_dem.html
+++ b/js/examples/maplibre_raster_dem.html
@@ -4,7 +4,7 @@
         <meta charset="utf-8"/>
         <link rel="stylesheet" href="https://unpkg.com/maplibre-gl@3.3.1/dist/maplibre-gl.css" crossorigin="anonymous">
         <script src="https://unpkg.com/maplibre-gl@3.3.1/dist/maplibre-gl.js" crossorigin="anonymous"></script>
-        <script src="https://unpkg.com/pmtiles@3.0.0-alpha.2/dist/index.js"></script>
+        <script src="https://unpkg.com/pmtiles@3.0.0/dist/index.js"></script>
         <style>
             body {
                 margin: 0;
diff --git a/js/package-lock.json b/js/package-lock.json
index 7211477..a5370f9 100644
--- a/js/package-lock.json
+++ b/js/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "pmtiles",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "pmtiles",
-      "version": "3.0.0-alpha.2",
+      "version": "3.0.0",
       "license": "BSD-3-Clause",
       "dependencies": {
         "@types/leaflet": "^1.9.8",
diff --git a/js/package.json b/js/package.json
index b2d96a9..f434e6f 100644
--- a/js/package.json
+++ b/js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pmtiles",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0",
   "description": "PMTiles archive decoder for browsers",
   "type": "module",
   "exports": "./dist/index.mjs",