perliedman / geojson-path-finder

Find shortest path through a network of GeoJSON
https://www.liedman.net/geojson-path-finder/
ISC License
300 stars 86 forks source link

Small updates to README #58

Closed kylebarron closed 4 years ago

kylebarron commented 4 years ago

A couple very small updates to the README:

  1. I was testing out the library and copy-pasting the example didn't work because of pathfinder vs pathFinder
  2. I originally expected weight to be returned in the same units as provided, i.e. degrees. It looks the default weightFn is turf.distance, whose default is kilometers, so I thought it would be helpful if the Readme specified the unit of the default weightFn.
perliedman commented 4 years ago

Thanks! :+1: Good catches, both of them.

kylebarron commented 4 years ago

Thanks. It seems like a great package and I'm excited to use it!