v3.1.0

bhousel · bhousel · commit 51cbc30578c5 · 2025-10-21T17:13:35.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,8 +14,9 @@ _Breaking changes, which may affect downstream projects, are marked with a_ ⚠
 
 [#xxx]: https://github.com/osmlab/osm-auth/issues/xxx
 -->
-# 3.1.0
-##### 2025-??
+
+## 3.1.0
+##### 2025-Oct-21
 * Remove Web Crypto API checking code and references to `window` ([#139],[#140], thanks [@tom-konda])
 * Detect if user tried to deny access in popup, notify BroadcastChannel ([#141], thanks [@ENT8R])
 * This project uses [`bun`](https://bun.com/) now for simpler developer tooling ([#142])
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ See also: https://wiki.openstreetmap.org/wiki/OAuth
 > [!IMPORTANT]
 > Due to [security changes on 8 July 2025](https://github.com/openstreetmap/openstreetmap-website/commit/2ff4d6), authentication using the `popup` mode will not work until you:
 >
-> 1. update this library to v3.0.0
+> 1. update this library to >= v3.0.0
 > 2. AND update the code snippet in your `land.html` file to the latest version (see [this example](https://github.com/osmlab/osm-auth/tree/master/land.html))
 
 
@@ -57,11 +57,18 @@ You can also use **osm-auth** directly in a web browser.  A good way to do this
 When you load this file in a `<script>` tag, you'll get a `osmAuth` global to use elsewhere in your scripts:
 ```html
 <head>
-<script src="https://cdn.jsdelivr.net/npm/osm-auth@3/dist/osm-auth.iife.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/osm-auth@latest/dist/osm-auth.iife.min.js"></script>
 </head>
 …
 <script>
-// example here
+  var redirectPath = window.location.origin + window.location.pathname;
+  var auth = osmAuth({
+    client_id: "…",
+    scope: "read_prefs",
+    redirect_uri: redirectPath + "land.html",
+    singlepage: true
+  });
+  …
 </script>
 ```
 
diff --git a/docs/index.html b/docs/index.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset='utf-8'/>
 <title>osm-auth</title>
-<script src="https://cdn.jsdelivr.net/npm/osm-auth@3/dist/osm-auth.iife.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/osm-auth@latest/dist/osm-auth.iife.min.js"></script>
 <link href='style.css' rel='stylesheet' type='text/css'/>
 </head>
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "osm-auth",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "license": "ISC",
   "repository": "github:osmlab/osm-auth",
   "description": "A usable example of JavaScript OAuth 2.0 with OpenStreetMap",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "osm-auth",`
`3`		`- "version": "3.0.0",`
	`3`	`+ "version": "3.1.0",`
`4`	`4`	`"license": "ISC",`
`5`	`5`	`"repository": "github:osmlab/osm-auth",`
`6`	`6`	`"description": "A usable example of JavaScript OAuth 2.0 with OpenStreetMap",`