summaryrefslogtreecommitdiff
path: root/platform/ios/docs/doc-README.md
diff options
context:
space:
mode:
Diffstat (limited to 'platform/ios/docs/doc-README.md')
-rw-r--r--platform/ios/docs/doc-README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/platform/ios/docs/doc-README.md b/platform/ios/docs/doc-README.md
new file mode 100644
index 0000000000..d3c4bd5e4a
--- /dev/null
+++ b/platform/ios/docs/doc-README.md
@@ -0,0 +1,9 @@
+# [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/)
+
+The Mapbox iOS SDK is an open-source framework for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS 7.0 and above using Objective-C, Swift, or Interface Builder. It takes stylesheets that conform to the [Mapbox GL Style Specification](https://www.mapbox.com/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://www.mapbox.com/developers/vector-tiles/), and renders them using OpenGL.
+
+[![](https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/ios/screenshot.png)]()
+
+For setup information, check out the [Mapbox iOS SDK homepage](https://www.mapbox.com/ios-sdk/). For detailed usage instructions, read “[First steps with the Mapbox iOS SDK](https://www.mapbox.com/help/first-steps-ios-sdk/)” and consult the [online examples](https://www.mapbox.com/ios-sdk/examples/). A [full changelog](https://github.com/mapbox/mapbox-gl-native/blob/master/CHANGELOG.md) is also available.
+
+If you have any questions, please [contact our support team](https://www.mapbox.com/contact/). We welcome your [bug reports and feature requests](https://github.com/mapbox/mapbox-gl-native/issues/).