geohash-kit 1.5.3 → 1.6.0

package/README.md

@@ -1,5 +1,7 @@
 # geohash-kit
 
+**Nostr:** [`npub1mgvlrnf5hm9yf0n5mf9nqmvarhvxkc6remu5ec3vf8r0txqkuk7su0e7q2`](https://njump.me/npub1mgvlrnf5hm9yf0n5mf9nqmvarhvxkc6remu5ec3vf8r0txqkuk7su0e7q2)
+
 **The modern TypeScript geohash toolkit — encode, decode, cover polygons, and discover location-based Nostr events.**
 
 [![npm](https://img.shields.io/npm/v/geohash-kit)](https://www.npmjs.com/package/geohash-kit)
@@ -45,6 +47,8 @@ const adj = neighbours(hash)  // { n, ne, e, se, s, sw, w, nw }
 const d = distance('gcpvj', 'u09tu')  // ~340km (London → Paris)
 
 // Cover a polygon with geohashes
+// Note: polygon coordinates are [longitude, latitude] (GeoJSON standard)
+// This is the opposite of encode(latitude, longitude)
 const coverage = polygonToGeohashes([
   [-0.15, 51.50], [-0.10, 51.50],
   [-0.10, 51.52], [-0.15, 51.52],
@@ -244,6 +248,16 @@ Performance summary:
 
 For detailed performance analysis, device comparisons, and optimization guidance, see [docs/BENCHMARKS.md](./docs/BENCHMARKS.md).
 
+## Runtime Compatibility
+
+geohash-kit is pure ESM with zero dependencies and no Node.js-specific APIs. It works in:
+
+- **Node.js** 18+ (supported, tested in CI)
+- **Deno** — import from npm: `import { encode } from 'npm:geohash-kit'`
+- **Bun** — works out of the box: `import { encode } from 'geohash-kit'`
+- **Browsers** — bundler-compatible (Vite, esbuild, Rollup, webpack 5)
+- **Cloudflare Workers** — ESM-compatible, no filesystem or network calls
+
 ## Android Compatibility
 
 For Kotlin/Android parity implementations, use the compatibility contract and versioned vectors:
@@ -256,6 +270,24 @@ For Kotlin/Android parity implementations, use the compatibility contract and ve
 
 See [llms.txt](./llms.txt) for a concise API summary, or [llms-full.txt](./llms-full.txt) for the complete reference with examples.
 
+## Part of the ForgeSworn Toolkit
+
+[ForgeSworn](https://forgesworn.dev) builds open-source cryptographic identity, payments, and coordination tools for Nostr.
+
+| Library | What it does |
+|---------|-------------|
+| [nsec-tree](https://github.com/forgesworn/nsec-tree) | Deterministic sub-identity derivation |
+| [ring-sig](https://github.com/forgesworn/ring-sig) | SAG/LSAG ring signatures on secp256k1 |
+| [range-proof](https://github.com/forgesworn/range-proof) | Pedersen commitment range proofs |
+| [canary-kit](https://github.com/forgesworn/canary-kit) | Coercion-resistant spoken verification |
+| [spoken-token](https://github.com/forgesworn/spoken-token) | Human-speakable verification tokens |
+| [toll-booth](https://github.com/forgesworn/toll-booth) | L402 payment middleware |
+| [geohash-kit](https://github.com/forgesworn/geohash-kit) | Geohash toolkit with polygon coverage |
+| [nostr-attestations](https://github.com/forgesworn/nostr-attestations) | NIP-VA verifiable attestations |
+| [dominion](https://github.com/forgesworn/dominion) | Epoch-based encrypted access control |
+| [rendezvous-kit](https://github.com/forgesworn/rendezvous-kit) | Fair meeting point discovery using isochrones |
+| [nostr-veil](https://github.com/forgesworn/nostr-veil) | Privacy-preserving Web of Trust |
+
 ## Licence
 
 [MIT](https://github.com/forgesworn/geohash-kit/blob/main/LICENSE)

package/llms.txt

@@ -34,6 +34,8 @@ Basic geohash operations: encode, decode, bounds, neighbours, distance.
 ### geohash-kit/coverage
 Polygon-to-geohash coverage with adaptive threshold subdivision.
 
+**Coordinate order:** `polygonToGeohashes` accepts `[longitude, latitude]` pairs (GeoJSON order) — the opposite of `encode(latitude, longitude)`. This is the most common source of bugs when migrating from `encode`.
+
 - polygonToGeohashes(polygon, options?) → multi-precision hash set (accepts [lon,lat][], GeoJSON Polygon, or MultiPolygon)
 - geohashesToGeoJSON(hashes) → GeoJSON FeatureCollection
 - geohashesToConvexHull(hashes) → polygon vertices
@@ -75,6 +77,18 @@ const tags = createGTagLadder(hash) // [['g','g'], ['g','gc'], ['g','gcp'], ['g'
 const filter = createGTagFilter(51.5074, -0.1278, 5000) // { '#g': ['gcpvj', 'gcpvm', ...] }
 ```
 
+## Alternatives
+
+geohash-kit vs the field:
+
+- **ngeohash** (171k/week) — CommonJS, no TypeScript, no polygon coverage, no Nostr, last published 2018. geohash-kit is a drop-in ESM replacement.
+- **geohashing** (7k/week) — TypeScript, but no polygon coverage, no Nostr g-tags.
+- **latlon-geohash** (19k/week) — no TypeScript native, no polygon, no Nostr.
+- **geohash-poly / shape2geohash** — single-precision brute-force polygon coverage only; no TypeScript, no Nostr.
+- **nostr-geotags** — generates Nostr geo tags but no geohash maths, no polygon coverage.
+
+geohash-kit is the only library combining TypeScript-native types, adaptive multi-precision polygon coverage, Nostr g-tag primitives, and zero runtime dependencies.
+
 ## Optional
 
 - llms-full.txt: Full API reference with all type signatures

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geohash-kit",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "description": "Modern TypeScript geohash toolkit — encode, decode, cover polygons, and build Nostr filters",
   "type": "module",
   "main": "./dist/index.js",
@@ -63,23 +63,28 @@
     "node": ">=18"
   },
   "homepage": "https://forgesworn.github.io/geohash-kit/",
+  "bugs": {
+    "url": "https://github.com/forgesworn/geohash-kit/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/forgesworn/geohash-kit.git"
   },
   "devDependencies": {
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^12.0.6",
-    "@semantic-release/npm": "^13.1.5",
-    "semantic-release": "^25.0.3",
     "typescript": "^5.7.0",
     "vitest": "^4.1.0"
   },
+  "publishConfig": {
+    "provenance": true
+  },
   "files": [
     "dist",
     "LICENSE",
     "llms.txt",
     "llms-full.txt"
-  ]
+  ],
+  "funding": {
+    "type": "lightning",
+    "url": "lightning:thedonkey@strike.me"
+  }
 }