diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..c51cf0a1d --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,20 @@ + + +**Platform:** +**Mapbox Services version:** + +### Steps to trigger behavior + + 1. + 2. + 3. + +### Expected behavior + +### Actual behavior diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..901b5ab5f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ + +### Description + +Write here and include any issues you are fixing. + +### Check List + +- [ ] Javadoc added to any methods included +- [ ] Added any test to ensure the fix works properly. diff --git a/.github/splash-img.png b/.github/splash-img.png new file mode 100644 index 000000000..2d17c30ac Binary files /dev/null and b/.github/splash-img.png differ diff --git a/README.md b/README.md index f633ecfc1..b393a6be8 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,12 @@ [![](https://www.mapbox.com/android-sdk/images/service-splash.png)](https://www.mapbox.com/android-sdk/#mapbox_android_services) [![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) - -# Mapbox Android Services (MAS) +This open source Mapbox project provides tools for building applications that need navigation, directions, geocoding, or static map imagery. -An open source toolset for building applications that need navigation, directions, geocoding, or static map imagery. +### Documentation -To avoid bringing unnecessary dependencies to Android projects, this project is split into specialized libraries: - -* `mapbox-java-core`: Java models shared across all modules. -* `mapbox-java-geojson`: Java support for GeoJSON objects (`Feature`, `FeatureCollection`, `Geometry`, `GeometryCollection`, `LineString`, `MultiLineString`, `MultiPoint`, `MultiPolygon`, `Point`, and `Polygon`). -* `mapbox-java-services`: Support for Mapbox APIs (directions, geocoding, map matching, distance, static image) including Turf. -* `mapbox-java-services-rx`: RxJava extensions for `mapbox-java-services`. -* `mapbox-android-services`: Drop-in replacement for the Android Geocoder using Mapbox services. -* `mapbox-android-telemetry`: Telemetry component for the [Mapbox Android SDK](https://www.mapbox.com/android-sdk/). -* `mapbox-android-ui`: Android-specific widgets, includes an autocomplete view for the Mapbox Geocoding API. - -### Features - -**Java & Android:** - -* [x] Integrate with the [Directions API](https://www.mapbox.com/directions/) -* [x] Integrate with the [Geocoding API](https://www.mapbox.com/geocoding/) -* [x] Integrate with the [Map Matching API](https://www.mapbox.com/blog/map-matching/) -* [x] Integrate with the [Distance API](https://www.mapbox.com/blog/distance-api/) -* [x] Integrate with the [Static Image API](https://www.mapbox.com/api-documentation/#static) -* [x] [Line simplification](https://www.mapbox.com/android-sdk/examples/polyline-simplification/) -* [x] Geospatial analysis functionality, adapted from the [Turf](http://turfjs.org/) project -* [x] `RouteUtils` for detecting when a user or marker location becomes off route to help you build navigation apps -* [x] Tidy which cleans noisy GPS traces removing repetitive coordinates from a GeoJSON Feature Collection - -**Android:** - -* [x] Ready-to-go geocoder input view with autocompletion. -* [x] Drop-in replacement for stock Android Geocoder object. - -### Installation - -All libraries listed above are available on Maven Central. You could simply: - -``` - -    com.mapbox.mapboxsdk -    mapbox-java-services -    1.3.1 - -``` - -or, in Gradle: - -``` -compile 'com.mapbox.mapboxsdk:mapbox-java-services:1.3.1' -``` - -Nightly snapshots are available on Sonatype. - -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). +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. ### Sample code @@ -64,4 +14,4 @@ Check the [Android Test App](https://github.com/mapbox/mapbox-java/tree/master/m ### Contributing -All libraries are contained within the `mapbox` folder. You can import the project using Android Studio or IntelliJ IDEA. +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.