diff options
Diffstat (limited to 'platform/ios/demo/README.md')
| -rw-r--r-- | platform/ios/demo/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/platform/ios/demo/README.md b/platform/ios/demo/README.md new file mode 100644 index 0000000000..74e2bca474 --- /dev/null +++ b/platform/ios/demo/README.md @@ -0,0 +1,18 @@ +# Mapbox iOS SDK Examples + +A live Xcode project/app that provides the Mapbox iOS SDK's [public examples](https://www.mapbox.com/ios-sdk/examples/). + +## How to receive help +We are not able to answer support questions in this repository — it is intended to show examples of what is possible with the Mapbox iOS SDK. If you have questions about how to use the Mapbox iOS SDK, please see our excellent [documentation](https://www.mapbox.com/help/) or ask the community at [Stack Overflow](http://stackoverflow.com/questions/tagged/mapbox+ios) + +### Other helpful links +- [Mapbox iOS SDK API documentation](https://www.mapbox.com/ios-sdk/api/) +- [First steps with the Mapbox iOS SDK](https://www.mapbox.com/help/first-steps-ios-sdk/) + +## Getting started +1. Run `pod install` to download and integrate dependencies using [CocoaPods](https://cocoapods.org). +1. Create the `mapbox_access_token` file in the base directory and insert your Mapbox access token. +1. Open `Examples.xcworkspace`. + +## Adding a new example +See the instructions in [`Examples.h`](Examples/Examples.h) for how to add new examples. |