Skip to content

Commit

Permalink
Merge pull request #7 from mapbox/update-docs
Browse files Browse the repository at this point in the history
Update readme just enough to open source the project
  • Loading branch information
boundsj authored Aug 2, 2017
2 parents 07fa605 + c3c6fcb commit 9f573df
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Turf-swift

**Warning:** The Turf-swift API is **experimental** and will change. It is published to be able to get feedback from the community. Please use with caution and open issues for any problems you see or missing features that should be added.

[![](https://www.bitrise.io/app/49f5bcca71bf6c8d/status.svg?token=SzGBTkEtxsbuAnbcF9MTog&branch=master)](https://www.bitrise.io/app/49f5bcca71bf6c8d)

A Swift language port of [Turf.js](http://turfjs.org).

### Installation

Although there has not yet been a beta release of this library yet, you can still experiment with it in your application by using CocoaPods to install it. Edit your Podfile to include:

```
pod 'Turf-swift', :git => 'git@github.com:mapbox/turf-swift.git'
```

Alternatively, you can clone this repo and drag and drop Turf.swift and CoreLocation.swift into your project in Xcode.

0 comments on commit 9f573df

Please sign in to comment.