From 65025428304b86aa005f18b98c363a4b02d94405 Mon Sep 17 00:00:00 2001 From: Steve Bennett Date: Wed, 26 Jun 2024 19:45:22 +1000 Subject: [PATCH] mention result distance in readme (#105) Document "distance" property. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 97ae873..403610c 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,11 @@ It will be guaranteed to be a global optimum within the given precision. Given polygon coordinates in [GeoJSON-like format](http://geojson.org/geojson-spec.html#polygon) and precision (`1.0` by default), -Polylabel returns the pole of inaccessibility coordinate in `[x, y]` format. +Polylabel returns the pole of inaccessibility coordinate in `[x, y]` format. The distance (in source units, usually degrees) is included as a `distance` property. ```js -var p = polylabel(polygon, 1.0); +const p = polylabel(polygon, 1.0); +const distance = p.distance; ``` ### TypeScript