Skip to content

Commit

Permalink
- updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-burton committed May 23, 2014
1 parent 85c577f commit 8531541
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@

##About

The AtApiWrapper is a android library that is a wrapper around the Auckland Transport public api.
The AtApiWrapper is a android library that is a wrapper around the [Auckland Transport public api](https://api.at.govt.nz).

Retrofit is used under the hood to perform all requests, which in turn uses OkHttp.

I reccommend having a read through the [Retrofit docs](http://square.github.io/retrofit/).


##Available endpoints

* Realtime
* GTFS (except shapes)

##How to use

Expand Down Expand Up @@ -49,13 +53,7 @@ The sample app is simple a practical example of how to query the api. It would b


###1. As a jar
Easy as


###2. As an aar

Put in a folder called libs, and add the following to your build.gradle:

Get the jar from the downloads page



Expand Down
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=http\://services.gradle.org/distributions/gradle-1.10-all.zip
distributionUrl=http\://services.gradle.org/distributions/gradle-1.12-all.zip
Empty file modified gradlew
100644 → 100755
Empty file.

0 comments on commit 8531541

Please sign in to comment.