diff options
author | Minh Nguyễn <mxn@1ec5.org> | 2016-01-22 12:15:50 -0800 |
---|---|---|
committer | Minh Nguyễn <mxn@1ec5.org> | 2016-01-22 14:45:58 -0800 |
commit | f65ff9ef30e7b110d70ba0486604f5f18db490f6 (patch) | |
tree | e77f7e0e5167dbe2f0c4375e72e260cb8ab19de6 /ios | |
parent | 83deed6a8873dca5163dfe8557a36b8289a2c6e5 (diff) | |
download | qtlocation-mapboxgl-f65ff9ef30e7b110d70ba0486604f5f18db490f6.tar.gz |
[ios] Split API index from package readme
The API index page serves a different purpose than the readme. It doesn’t need installation instructions, but it does need a brief What’s New section.
Diffstat (limited to 'ios')
-rw-r--r-- | ios/docs/doc-README.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/ios/docs/doc-README.md b/ios/docs/doc-README.md new file mode 100644 index 0000000000..59cc8bd2d3 --- /dev/null +++ b/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://github.com/mapbox/mapbox-gl-style-spec/), applies them to vector tiles that conform to the [Mapbox Vector Tile Specification](https://github.com/mapbox/vector-tile-spec), and renders them using OpenGL. + +[![](https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/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/guides/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 <mobile@mapbox.com>. We welcome your [bug reports and feature requests](https://github.com/mapbox/mapbox-gl-native/issues/). |