summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom MacWright <tom@macwright.org>2015-10-26 11:36:19 -0400
committerTom MacWright <tom@macwright.org>2015-10-27 16:43:54 -0400
commit3fca2455ad8d9734d35c68333b14b104f3d5de5b (patch)
tree6bd3b999302b81514c9c6c1ecb388098dc9b24e5 /README.md
parentaf5271cd3ec6b86d7121201243c1678426e64b62 (diff)
downloadqtlocation-mapboxgl-3fca2455ad8d9734d35c68333b14b104f3d5de5b.tar.gz
[docs] Recreate structure of documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 20 insertions, 9 deletions
diff --git a/README.md b/README.md
index d30628837c..c2fb791871 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,29 @@
-# Mapbox GL (Native)
+# Mapbox GL Native
[![Travis](https://api.travis-ci.org/mapbox/mapbox-gl-native.svg?branch=master)](https://travis-ci.org/mapbox/mapbox-gl-native/builds) [![Bitrise](https://www.bitrise.io/app/7514e4cf3da2cc57.svg?token=OwqZE5rSBR9MVWNr_lf4sA&branch=master)](https://www.bitrise.io/app/7514e4cf3da2cc57)
-An OpenGL ES-based renderer for [Mapbox Vector Tiles](https://www.mapbox.com/blog/vector-tiles), consisting of a C++ library for OS X and Linux and SDK bindings for iOS, Android and Node.js.
+An OpenGL-based renderer for [Mapbox Vector Tiles](https://www.mapbox.com/blog/vector-tiles), consisting of a C++ library for OS X and Linux and SDK bindings for iOS, Android and Node.js.
-**This repository is for development on Mapbox GL itself.**
+**This repository is for development on Mapbox GL Native itself.**
-If you want to use products _based on_ Mapbox GL, check out:
+If you want to use products _based on_ Mapbox GL, check out:
-- [Mapbox Mobile](http://mapbox.com/mobile) — iOS and Android native development libraries for vector maps in apps
-- [`react-native-mapbox-gl`](https://github.com/mapbox/react-native-mapbox-gl) — React Native library for vector maps in apps
-- [`qmapboxgl`](https://github.com/tmpsantos/qmapboxgl) — Qt library for vector map rendering
-- [`Mapbox Cordova Plugin`](http://plugins.telerik.com/cordova/plugin/mapbox) - Telerik's Apache Cordova plugin for vector maps in apps
+- [Mapbox Mobile](http://mapbox.com/mobile) — iOS and Android native development libraries
+- [`mapbox-gl-native`](https://www.npmjs.com/package/mapbox-gl-native) - Node.js native module
+- [`react-native-mapbox-gl`](https://github.com/mapbox/react-native-mapbox-gl) — React Native library
+- [`qmapboxgl`](https://github.com/tmpsantos/qmapboxgl) — Qt library
+- [`Mapbox Cordova Plugin`](http://plugins.telerik.com/cordova/plugin/mapbox) - Telerik's Apache Cordova plugin
--
-See [`INSTALL.md`](./INSTALL.md) for development setup and install instructions, including dependencies.
+## Targets
+
+* Ubuntu Linux
+* OS X 10.9+
+* iOS 7.0+
+ * iPhone 4S and above (5, 5c, 5s, 6, 6 Plus)
+ * iPad 2 and above (3, 4, Mini, Air, Mini 2, Air 2)
+ * iPod touch 5th gen and above
+* Android 4.0+ (API level 14+)
+
+See [`INSTALL.md`](./INSTALL.md) for development setup and install instructions, including dependencies.