Skip to content

Commit 5e9ca8a

Browse files
authored
update readme with new modules and contributing information (#308)
1 parent 8c0d2bd commit 5e9ca8a

1 file changed

Lines changed: 35 additions & 4 deletions

File tree

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,19 @@
33
[![Build Status](https://www.bitrise.io/app/a7eea7d04be1e2e5.svg?token=OruuJNhnjyeRnlBv0wXsFQ&branch=master)](https://www.bitrise.io/app/a7eea7d04be1e2e5) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.mapbox.mapboxsdk/mapbox-android-services/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.mapbox.mapboxsdk/mapbox-android-services)
44
<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>
55

6+
# Mapbox Android Services (MAS)
67

8+
An open source toolset for building applications that need navigation, directions, geocoding, or static map imagery.
79

8-
# Mapbox Android Services (MAS)
10+
To avoid bringing unnecessary dependencies to Android projects, this project is split into specialized libraries:
911

10-
An open source toolset for building applications that need directions, geocoding, or static map imagery. Two libraries are at your disposal: a **Java library** compatible with any Java application and an **Android library** intended to be used specifically for Android applications.
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.
1119

1220
### Features
1321

@@ -16,10 +24,11 @@ An open source toolset for building applications that need directions, geocoding
1624
* [x] Integrate with the [Directions API](https://www.mapbox.com/directions/)
1725
* [x] Integrate with the [Geocoding API](https://www.mapbox.com/geocoding/)
1826
* [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/)
1928
* [x] Integrate with the [Static Image API](https://www.mapbox.com/api-documentation/#static)
2029
* [x] [Line simplification](https://www.mapbox.com/android-sdk/examples/polyline-simplification/)
2130
* [x] Geospatial analysis functionality, adapted from the [Turf](http://turfjs.org/) project
22-
* [x] RouteUtils for detecting when a user or marker location becomes off route
31+
* [x] `RouteUtils` for detecting when a user or marker location becomes off route to help you build navigation apps
2332
* [x] Tidy which cleans noisy GPS traces removing repetitive coordinates from a GeoJSON Feature Collection
2433

2534
**Android:**
@@ -29,8 +38,30 @@ An open source toolset for building applications that need directions, geocoding
2938

3039
### Installation
3140

32-
To install and use MAS in an application, see the [Mapbox Android Services website](https://www.mapbox.com/android-sdk/#mapbox_android_services).
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).
3360

3461
### Sample code
3562

3663
Check the [Android Test App](https://github.com/mapbox/mapbox-java/tree/master/libandroid/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+
65+
### Contributing
66+
67+
All libraries are contained within the `mapbox` folder. You can import the project using Android Studio or IntelliJ IDEA.

0 commit comments

Comments
 (0)