summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlangsmith <langstonlmcs@gmail.com>2019-02-26 11:23:53 -0800
committerlangsmith <langstonlmcs@gmail.com>2019-02-26 11:23:53 -0800
commit459e5bda76a6d3da3908f8bead84457d858ac0cc (patch)
treeda39301477b30a3060d392bbd25c721e4034975f
parent570f0a1432db727f6a98c9354165a26bba9f3637 (diff)
downloadqtlocation-mapboxgl-upstream/ls-android-readme-docs-link-fix.tar.gz
[android] Android README link and writing updatesupstream/ls-android-readme-docs-link-fix
-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