Skip to content

Commit ef1ebfb

Browse files
Langston Smithosana
authored andcommitted
Added Turf README (#812)
* Added README Line removal comma removal * Blank line removal
1 parent 55b5ff5 commit ef1ebfb

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

services-turf/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Turf for Java
2+
3+
[![CircleCI](https://circleci.com/gh/mapbox/mapbox-java.svg?style=svg)](https://circleci.com/gh/mapbox/mapbox-java)
4+
5+
Turf for Java is a [spatial analysis](http://en.wikipedia.org/wiki/Spatial_analysis) library written for Java SE and Android applications. It is ported from the [Turf.js](https://github.com/Turfjs/turf/) library.
6+
7+
Turf for Java is **experimental** and its public API is subject to change. Please use with care and open issues for any problems you see or missing features that should be added.
8+
9+
Visit [https://github.com/mapbox/mapbox-java](https://github.com/mapbox/mapbox-java) for more information about help with Turf for Java, using SNAPSHOTs, contributing your own code, and more.
10+
11+
## Installation
12+
13+
Either Gradle or Maven can be used to install the Turf dependency. Visit [mapbox.com/android-docs/java-sdk/overview/#installation](https://www.mapbox.com/android-docs/java-sdk/overview/#installation) for more in-depth installation instructions.
14+
15+
## Available functionality
16+
17+
[This list](https://github.com/mapbox/mapbox-java/blob/master/docs/turf-port.md) shows the progress made in porting [the various Turf.js methods](http://turfjs.org/docs/) to Java.
18+
19+
Please make a ticket in this repository if there's a Turf.js method that you'd like to see ported to Java.

0 commit comments

Comments
 (0)