rendezvous-kit 1.21.3 → 1.21.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -5
- package/llms-full.txt +2 -2
- package/llms.txt +1 -1
- package/package.json +12 -6
package/README.md
CHANGED
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
**Find fair meeting points for N people — isochrone intersection, venue search, and fairness scoring.**
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/rendezvous-kit)
|
|
6
|
-
[](https://github.com/
|
|
6
|
+
[](https://github.com/forgesworn/rendezvous-kit/blob/main/LICENSE)
|
|
7
7
|
|
|
8
8
|
[](https://primal.net/p/npub1mgvlrnf5hm9yf0n5mf9nqmvarhvxkc6remu5ec3vf8r0txqkuk7su0e7q2)
|
|
9
9
|
|
|
10
|
-
**[Live Demo →](https://
|
|
10
|
+
**[Live Demo →](https://forgesworn.github.io/rendezvous-kit)**
|
|
11
11
|
|
|
12
12
|
### How it works
|
|
13
13
|
|
|
@@ -209,12 +209,27 @@ class MyEngine implements RoutingEngine {
|
|
|
209
209
|
}
|
|
210
210
|
```
|
|
211
211
|
|
|
212
|
+
## Examples
|
|
213
|
+
|
|
214
|
+
Runnable examples in [`examples/`](./examples/):
|
|
215
|
+
|
|
216
|
+
- **[basic-usage.ts](./examples/basic-usage.ts)** — find a fair meeting point for three people
|
|
217
|
+
- **[comparing-fairness-strategies.ts](./examples/comparing-fairness-strategies.ts)** — see how min_max, min_total, and min_variance rank differently
|
|
218
|
+
- **[custom-engine.ts](./examples/custom-engine.ts)** — implement the RoutingEngine interface with a mock engine
|
|
219
|
+
|
|
220
|
+
Run any example with `npx tsx examples/<name>.ts`.
|
|
221
|
+
|
|
222
|
+
## Guides
|
|
223
|
+
|
|
224
|
+
- **[Choosing a Fairness Strategy](./docs/choosing-a-fairness-strategy.md)** — when to use min_max vs min_total vs min_variance
|
|
225
|
+
- **[Self-Hosting a Routing Engine](./docs/self-hosting-a-routing-engine.md)** — run Valhalla, OSRM, or GraphHopper locally with Docker
|
|
226
|
+
|
|
212
227
|
## Companion Library
|
|
213
228
|
|
|
214
229
|
**geohash-kit** — spatial primitives (pointInPolygon, GeoJSON types, distance utilities) used internally by rendezvous-kit.
|
|
215
230
|
|
|
216
231
|
- npm: [`geohash-kit`](https://www.npmjs.com/package/geohash-kit)
|
|
217
|
-
- GitHub: [`
|
|
232
|
+
- GitHub: [`forgesworn/geohash-kit`](https://github.com/forgesworn/geohash-kit)
|
|
218
233
|
|
|
219
234
|
## For AI Assistants
|
|
220
235
|
|
|
@@ -239,11 +254,11 @@ OSRM cannot generate isochrones. Use Valhalla, OpenRouteService, or GraphHopper
|
|
|
239
254
|
|
|
240
255
|
## Licence
|
|
241
256
|
|
|
242
|
-
[MIT](https://github.com/
|
|
257
|
+
[MIT](https://github.com/forgesworn/rendezvous-kit/blob/main/LICENSE)
|
|
243
258
|
|
|
244
259
|
## Support
|
|
245
260
|
|
|
246
|
-
For issues and feature requests, see [GitHub Issues](https://github.com/
|
|
261
|
+
For issues and feature requests, see [GitHub Issues](https://github.com/forgesworn/rendezvous-kit/issues).
|
|
247
262
|
|
|
248
263
|
If you find rendezvous-kit useful, consider sending a tip:
|
|
249
264
|
|
package/llms-full.txt
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
One runtime dependency: geohash-kit. Zero third-party dependencies. ESM-only.
|
|
6
6
|
|
|
7
|
-
Repository: https://github.com/
|
|
7
|
+
Repository: https://github.com/forgesworn/rendezvous-kit
|
|
8
8
|
Licence: MIT
|
|
9
9
|
|
|
10
10
|
## Install
|
|
@@ -477,5 +477,5 @@ const suggestions = await findRendezvous(new MyRoutingEngine(), options)
|
|
|
477
477
|
|
|
478
478
|
**geohash-kit** — spatial primitives used internally by rendezvous-kit.
|
|
479
479
|
|
|
480
|
-
- Repository: https://github.com/
|
|
480
|
+
- Repository: https://github.com/forgesworn/geohash-kit
|
|
481
481
|
- npm: geohash-kit
|
package/llms.txt
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rendezvous-kit",
|
|
3
|
-
"version": "1.21.
|
|
3
|
+
"version": "1.21.5",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Find fair meeting points for N people — isochrone intersection, venue search, and fairness scoring.",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -41,10 +41,10 @@
|
|
|
41
41
|
"@semantic-release/changelog": "^6.0.3",
|
|
42
42
|
"@semantic-release/git": "^10.0.1",
|
|
43
43
|
"@semantic-release/github": "^12.0.6",
|
|
44
|
-
"@semantic-release/npm": "^13.1.
|
|
44
|
+
"@semantic-release/npm": "^13.1.5",
|
|
45
45
|
"semantic-release": "^25.0.3",
|
|
46
46
|
"typescript": "^5.7.0",
|
|
47
|
-
"vitest": "^
|
|
47
|
+
"vitest": "^4.1.0"
|
|
48
48
|
},
|
|
49
49
|
"files": [
|
|
50
50
|
"dist",
|
|
@@ -55,9 +55,15 @@
|
|
|
55
55
|
"keywords": [
|
|
56
56
|
"rendezvous",
|
|
57
57
|
"meeting-point",
|
|
58
|
+
"meet-in-the-middle",
|
|
58
59
|
"isochrone",
|
|
59
60
|
"fairness",
|
|
60
61
|
"routing",
|
|
62
|
+
"travel-time",
|
|
63
|
+
"polygon-intersection",
|
|
64
|
+
"venue-search",
|
|
65
|
+
"overpass",
|
|
66
|
+
"geojson",
|
|
61
67
|
"valhalla",
|
|
62
68
|
"openrouteservice",
|
|
63
69
|
"graphhopper",
|
|
@@ -70,13 +76,13 @@
|
|
|
70
76
|
"engines": {
|
|
71
77
|
"node": ">=18"
|
|
72
78
|
},
|
|
73
|
-
"author": "
|
|
79
|
+
"author": "forgesworn",
|
|
74
80
|
"license": "MIT",
|
|
75
81
|
"repository": {
|
|
76
82
|
"type": "git",
|
|
77
|
-
"url": "https://github.com/
|
|
83
|
+
"url": "https://github.com/forgesworn/rendezvous-kit.git"
|
|
78
84
|
},
|
|
79
|
-
"homepage": "https://github.com/
|
|
85
|
+
"homepage": "https://github.com/forgesworn/rendezvous-kit",
|
|
80
86
|
"funding": {
|
|
81
87
|
"type": "lightning",
|
|
82
88
|
"url": "https://strike.me/thedonkey"
|