| 1 | # @turf/turf
|
| 2 |
|
| 3 | # turf
|
| 4 |
|
| 5 | Turf is a modular geospatial analysis engine written in JavaScript. It performs geospatial
|
| 6 | processing tasks with GeoJSON data and can be run on a server or in a browser.
|
| 7 |
|
| 8 | |
| 9 | if you find an error, edit the source file (likely index.js), and re-run
|
| 10 | ./scripts/generate-readmes in the turf project. -->
|
| 11 |
|
| 12 | ---
|
| 13 |
|
| 14 | This module is part of the [Turfjs project](http://turfjs.org/), an open source
|
| 15 | module collection dedicated to geographic algorithms. It is maintained in the
|
| 16 | [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
|
| 17 | PRs and issues.
|
| 18 |
|
| 19 | ### Installation
|
| 20 |
|
| 21 | Install this module individually:
|
| 22 |
|
| 23 | ```sh
|
| 24 | $ npm install @turf/turf
|
| 25 | ```
|
| 26 |
|
| 27 | Or install the Turf module that includes it as a function:
|
| 28 |
|
| 29 | ```sh
|
| 30 | $ npm install @turf/turf
|
| 31 | ```
|