-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from mapbox/update-docs
Update readme just enough to open source the project
- Loading branch information
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |