summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLangston Smith <langston.smith@mapbox.com>2019-02-27 07:25:18 -0800
committerGitHub <noreply@github.com>2019-02-27 07:25:18 -0800
commita0c3e2321def1c5ad8b45f529f5302a0f53c831b (patch)
treeb717c85c801a63272973f8bc818657839fb6da75
parentdd651691f37ecf9e2d59146b190d734e9a4e6148 (diff)
downloadqtlocation-mapboxgl-a0c3e2321def1c5ad8b45f529f5302a0f53c831b.tar.gz
[android] Android README link and writing updates (#13995)
-rw-r--r--platform/android/README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/platform/android/README.md b/platform/android/README.md
index 3c82458539..85eeae52e0 100644
--- a/platform/android/README.md
+++ b/platform/android/README.md
@@ -2,21 +2,27 @@
[![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master)
+[![](https://www.mapbox.com/android-docs/assets/overview-map-sdk-322-9abe118316efb5910b6101e222a2e57c.png)](https://docs.mapbox.com/android/maps/overview/)
+
A library based on [Mapbox GL Native](../../README.md) for embedding interactive map views with scalable, customizable vector maps onto Android devices.
## Getting Started
-Alright. So, actually, you may be in the wrong place. From here on in, this README is going to be for people who are interested in working on and improving on Mapbox GL Native for Android.
+Alright. So, actually, you may be in the wrong place. From here on in, this README is going to be for people who are interested in working on and improving the Maps SDK for Android.
+
+Visit [https://docs.mapbox.com/android/maps/overview](https://docs.mapbox.com/android/maps/overview/) to see current documentation on the Maps SDK for Android.
+
+To view the current API Javadoc files on the Maps SDK for Android, visit [https://docs.mapbox.com/android/maps/overview](https://docs.mapbox.com/android/maps/overview) and click on `API Reference` towards the top of the page
-**To view our current API documentation, see our [JavaDoc](https://www.mapbox.com/android-sdk/api).**
+![screen shot 2019-02-26 at 11 21 17 am](https://user-images.githubusercontent.com/4394910/53440121-a9f9d900-39b8-11e9-99c0-93719dae4c18.png)
+
-**To install and use the Mapbox Maps SDK for Android in an application, see the [Mapbox Maps SDK for Android website](https://www.mapbox.com/install/android/).**
+To install and use the Mapbox Maps SDK for Android in an application, see [the Mapbox website's Android install flow](https://www.mapbox.com/install/android/).
-[![](https://www.mapbox.com/android-docs/assets/overview-map-sdk-322-9abe118316efb5910b6101e222a2e57c.png)](https://www.mapbox.com/android-sdk/)
### Setup environment
-**These instructions are for developers interested in making code-level contributions to the SDK itself. If you instead want to use the SDK in your app, see above.**
+These instructions are for developers interested in making code-level contributions to the SDK itself. If you instead want to use the SDK in your app, see above.
#### Getting the source