mirror of
https://github.com/Turfjs/turf.git
synced 2026-01-25 16:07:00 +00:00
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>
70 lines
4.6 KiB
Markdown
70 lines
4.6 KiB
Markdown
|
|
======
|
|
[](https://github.com/Turfjs/turf/actions/workflows/turf.yml/badge.svg)
|
|
[![Version Badge][npm-img]][npm-url]
|
|
[![Gitter chat][gitter-img]][gitter-url]
|
|
[![Backers on Open Collective][oc-backer-badge]](#backers)
|
|
[![Sponsors on Open Collective][oc-sponsor-badge]](#sponsors) [](https://coveralls.io/github/Turfjs/turf)
|
|
|
|
[npm-img]: https://img.shields.io/npm/v/@turf/turf.svg
|
|
[npm-url]: https://www.npmjs.com/package/@turf/turf
|
|
[gitter-img]: https://badges.gitter.im/Turfjs/turf.svg
|
|
[gitter-url]: https://gitter.im/Turfjs/turf
|
|
[oc-backer-badge]: https://opencollective.com/turf/backers/badge.svg
|
|
[oc-sponsor-badge]: https://opencollective.com/turf/sponsors/badge.svg
|
|
|
|
***A modular geospatial engine written in JavaScript***
|
|
|
|
[Turf](https://turfjs.org) is a [JavaScript library](https://en.wikipedia.org/wiki/JavaScript_library) for [spatial analysis](https://en.wikipedia.org/wiki/Spatial_analysis). It includes traditional spatial operations, helper functions for creating [GeoJSON](https://geojson.org) 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](https://www.npmjs.com/package/@turf/turf) with [Node.js](https://nodejs.org/) (see below).
|
|
|
|
|
|
## Getting Started
|
|
|
|
Read our [getting started guide](https://turfjs.org/docs/getting-started) to begin working with Turf.
|
|
|
|
Or explore the Turf API and examples at [turfjs.org](https://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](https://nodejs.org/en/about/previous-releases) 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](https://github.com/browserslist/browserslist):
|
|
|
|
[> 0.25%, last 2 versions, fully supports es5, not dead](https://browsersl.ist/#q=%3E+0.25%25%2C+last+2+versions%2C+fully+supports+es5%2C+not+dead)
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. If you are interested in helping, check out the [Contributing Guide](docs/CONTRIBUTING.md).
|
|
|
|
<a href="https://github.com/Turfjs/turf/graphs/contributors"><img src="https://opencollective.com/turf/contributors.svg?width=890&button=false" /></a>
|
|
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/turf#backer)]
|
|
|
|
<a href="https://opencollective.com/turf#backers" target="_blank"><img src="https://opencollective.com/turf/backers.svg?width=890"></a>
|
|
|
|
|
|
## Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/turf#sponsor)]
|
|
|
|
<a href="https://opencollective.com/turf/sponsor/0/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/1/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/2/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/3/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/4/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/5/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/6/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/7/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/8/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/turf/sponsor/9/website" target="_blank"><img src="https://opencollective.com/turf/sponsor/9/avatar.svg"></a>
|