|
1 | 1 | [](https://www.mapbox.com/android-sdk/#mapbox_android_services) |
2 | 2 |
|
3 | 3 | [](https://www.bitrise.io/app/a7eea7d04be1e2e5) [](https://maven-badges.herokuapp.com/maven-central/com.mapbox.mapboxsdk/mapbox-android-services) |
4 | | -<a href="http://www.methodscount.com/?lib=com.mapbox.mapboxsdk%3Amapbox-java-services%3A1.3.1"><img src="https://img.shields.io/badge/Methods count-core: 690 | deps: 4795-e91e63.svg"/></a> |
5 | 4 |
|
6 | | -# Mapbox Android Services (MAS) |
| 5 | +This open source Mapbox project provides tools for building applications that need navigation, directions, geocoding, or static map imagery. |
7 | 6 |
|
8 | | -An open source toolset for building applications that need navigation, directions, geocoding, or static map imagery. |
| 7 | +### Documentation |
9 | 8 |
|
10 | | -To avoid bringing unnecessary dependencies to Android projects, this project is split into specialized libraries: |
11 | | - |
12 | | -* `mapbox-java-core`: Java models shared across all modules. |
13 | | -* `mapbox-java-geojson`: Java support for GeoJSON objects (`Feature`, `FeatureCollection`, `Geometry`, `GeometryCollection`, `LineString`, `MultiLineString`, `MultiPoint`, `MultiPolygon`, `Point`, and `Polygon`). |
14 | | -* `mapbox-java-services`: Support for Mapbox APIs (directions, geocoding, map matching, distance, static image) including Turf. |
15 | | -* `mapbox-java-services-rx`: RxJava extensions for `mapbox-java-services`. |
16 | | -* `mapbox-android-services`: Drop-in replacement for the Android Geocoder using Mapbox services. |
17 | | -* `mapbox-android-telemetry`: Telemetry component for the [Mapbox Android SDK](https://www.mapbox.com/android-sdk/). |
18 | | -* `mapbox-android-ui`: Android-specific widgets, includes an autocomplete view for the Mapbox Geocoding API. |
19 | | - |
20 | | -### Features |
21 | | - |
22 | | -**Java & Android:** |
23 | | - |
24 | | -* [x] Integrate with the [Directions API](https://www.mapbox.com/directions/) |
25 | | -* [x] Integrate with the [Geocoding API](https://www.mapbox.com/geocoding/) |
26 | | -* [x] Integrate with the [Map Matching API](https://www.mapbox.com/blog/map-matching/) |
27 | | -* [x] Integrate with the [Distance API](https://www.mapbox.com/blog/distance-api/) |
28 | | -* [x] Integrate with the [Static Image API](https://www.mapbox.com/api-documentation/#static) |
29 | | -* [x] [Line simplification](https://www.mapbox.com/android-sdk/examples/polyline-simplification/) |
30 | | -* [x] Geospatial analysis functionality, adapted from the [Turf](http://turfjs.org/) project |
31 | | -* [x] `RouteUtils` for detecting when a user or marker location becomes off route to help you build navigation apps |
32 | | -* [x] Tidy which cleans noisy GPS traces removing repetitive coordinates from a GeoJSON Feature Collection |
33 | | - |
34 | | -**Android:** |
35 | | - |
36 | | -* [x] Ready-to-go geocoder input view with autocompletion. |
37 | | -* [x] Drop-in replacement for stock Android Geocoder object. |
38 | | - |
39 | | -### Installation |
40 | | - |
41 | | -All libraries listed above are available on Maven Central. You could simply: |
42 | | - |
43 | | -``` |
44 | | -<dependency> |
45 | | - <groupId>com.mapbox.mapboxsdk</groupId> |
46 | | - <artifactId>mapbox-java-services</artifactId> |
47 | | - <version>1.3.1</version> |
48 | | -</dependency> |
49 | | -``` |
50 | | - |
51 | | -or, in Gradle: |
52 | | - |
53 | | -``` |
54 | | -compile 'com.mapbox.mapboxsdk:mapbox-java-services:1.3.1' |
55 | | -``` |
56 | | - |
57 | | -Nightly snapshots are available on Sonatype. |
58 | | - |
59 | | -For more details on how to install and use MAS in an application, see the [Mapbox Android Services website](https://www.mapbox.com/android-sdk/#mapbox_android_services). |
| 9 | +You'll find all the documentation for this SDK on [our website](https://www.mapbox.com/android-docs/mapbox-services/), this includes information on installation, using the APIs, and also includes links to the javadoc. |
60 | 10 |
|
61 | 11 | ### Sample code |
62 | 12 |
|
63 | 13 | Check the [Android Test App](https://github.com/mapbox/mapbox-java/tree/master/mapbox/app) for examples or download the [Mapbox Demo App](https://play.google.com/store/apps/details?id=com.mapbox.mapboxandroiddemo) to see what's possible with Mapbox Android Services. You can also visit the [Mapbox Android SDK examples page](https://www.mapbox.com/android-sdk/examples/) for additional code examples. |
64 | 14 |
|
65 | 15 | ### Contributing |
66 | 16 |
|
67 | | -All libraries are contained within the `mapbox` folder. You can import the project using Android Studio or IntelliJ IDEA. |
| 17 | +All libraries are contained within the `mapbox` folder. You can import the project using Android Studio or IntelliJ IDEA. Read the [contribution](https://github.com/mapbox/mapbox-java/blob/master/CONTRIBUTING.md) guide to get setup properly. |
0 commit comments