a8cbea3a48
* Moved "optional" project documentation files to docs/ subdir to minimise clutter in project root. * Verbatim copy of Contributor Covenant v2.1. Updated code of conduct contact details, removing anyone who don't list obvious contact details (@lyzidiamond and @tcql). * Split publishing topic out into a separate document. Only a small subset of contributors will ever publish so better to have CONTRIBUTING focus on coding and PR related activities. * Updated issue and PR templates to read a bit better, ask for more meaningful details. * Updating open collective stats, project goals for coming year. * Split readme into a few pieces. Cut a lot of cut and paste commands (hard to guarantee currency). Removed REGEN references - think it's use should be discouraged, though probably differing opinions on that one! Co-authored-by: mfedderly <24275386+mfedderly@users.noreply.github.com> Co-authored-by: Tim Welch <tim.j.welch@gmail.com> --------- Co-authored-by: mfedderly <24275386+mfedderly@users.noreply.github.com> Co-authored-by: Tim Welch <tim.j.welch@gmail.com>
4.6 KiB
A modular geospatial engine written in JavaScript
Turf is a JavaScript library for spatial analysis. It includes traditional spatial operations, helper functions for creating GeoJSON data, and data classification and statistics tools. Turf can be added to your website as a client-side module, or you can run Turf server-side with Node.js (see below).
Getting Started
Read our getting started guide to begin working with Turf.
Or explore the Turf API and examples at turfjs.org.
Runtime support
Turf is currently published to work with any reasonably modern Javascript runtime.
Node is a first class citizen, and we recommend using an Active or Maintenance LTS release.
Other runtimes, such as Deno or Bun, are not officially supported. We would be very interested to hear your experiences though.
Browser support
Turf uses Babel to transpile to a JavaScript version usable by most modern browsers. Any browser that matches the following criteria as defined by Browserslist:
> 0.25%, last 2 versions, fully supports es5, not dead
Contributors
This project exists thanks to all the people who contribute. If you are interested in helping, check out the Contributing Guide.
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
