Skip to content

Commit 1fe582b

Browse files
author
Cameron Mace
authored
Added snapshot and a bit more information to readme file (#413)
* added snapshot and a bit more information to readme file * removed PR template * readded pull request template * Update README.md
1 parent 9ce67ca commit 1fe582b

1 file changed

Lines changed: 31 additions & 6 deletions

File tree

README.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,41 @@
22

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

5-
This open source Mapbox project provides tools for building applications that need navigation, directions, geocoding, or static map imagery.
5+
Mapbox Android Services contains navigation, directions, geocoding, and many more APIs to use inside your Android or Java application. This repository holds the source code for the project and is divided into several modules to make it easier for developers to only include the dependencies needed for their project.
66

7-
### Documentation
7+
## Getting Started
88

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.
9+
If you are looking to include this inside your project, please take a look at [the detailed instructions](https://www.mapbox.com/android-docs/mapbox-services/) found in our docs. If you are interested in building from source, read the contributing guide inside this project.
1010

11-
### Sample code
11+
## Documentation
12+
13+
You'll find all of the documentation for this SDK on [our Mapbox Services page](https://www.mapbox.com/android-docs/mapbox-services/). This includes information on installation, using the APIs, and links to the API reference.
14+
15+
## Getting Help
16+
17+
- **Need help with your code?**: Look for previous questions on the [#mapbox tag](https://stackoverflow.com/questions/tagged/mapbox+android) — or [ask a new question](https://stackoverflow.com/questions/tagged/mapbox+android).
18+
- **Have a bug to report?** [Open an issue](https://github.com/mapbox/mapbox-java/issues/new). If possible, include the version of Mapbox Services, a full log, and a project that shows the issue.
19+
- **Have a feature request?** [Open an issue](https://github.com/mapbox/mapbox-java/issues/new). Tell us what the feature should do and why you want the feature.
20+
21+
## Using Snapshots
22+
23+
If you want to test recent bugfixes or features that have not been packaged in an official release yet, you can use a `-SNAPSHOT` release of the current development version of Mapbox Services via Gradle, available on [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/mapbox/mapboxsdk/). There are several different snapshots built nightly. Feel free to use any of the modules as needed.
24+
25+
```gradle
26+
repositories {
27+
mavenCentral()
28+
maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
29+
}
30+
31+
dependencies {
32+
compile 'com.mapbox.mapboxsdk:mapbox-android-services:2.1.0-SNAPSHOT'
33+
}
34+
```
35+
36+
## Sample code
1237

1338
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.
1439

15-
### Contributing
40+
## Contributing
1641

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.
42+
All libraries are contained within the `mapbox` folder. You can import the project using Android Studio or IntelliJ IDEA. Read [the contribution guide](https://github.com/mapbox/mapbox-java/blob/master/CONTRIBUTING.md) to get setup properly.

0 commit comments

Comments
 (0)