Skip to content
This repository was archived by the owner on Oct 28, 2025. It is now read-only.

Commit 188b5a8

Browse files
authored
Update README.md
1 parent 7857d2d commit 188b5a8

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Here is an example of retrieving an array of teams in the FIRST Mid-Atlantic dis
2323

2424
A list of request methods for each request object can be found [here](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/package-summary.html).
2525

26-
### Advance Usage
26+
### Advanced Usage
2727

28-
If you want to utilize the `If-Modified-Since` and `Last-Modified` headers, you will need to make a direct URL request with the [`getDataTBA(String urlDirectory)` method](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/DataRequest.html#getDataTBA-java.lang.String-java.lang.String-) in the [`DataRequest` class](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/DataRequest.html). This will return an [`APIResponse`](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/APIResponse.html) object with JSON data, the HTTP response code, and the `Last-Modified` header.
28+
If you want to utilize the `If-Modified-Since` and `Last-Modified` headers, you will need to make a direct URL request with the [`getDataTBA(String urlDirectory, String ifModifiedSince)` method](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/DataRequest.html#getDataTBA-java.lang.String-java.lang.String-) in the [`DataRequest` class](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/DataRequest.html). This will return an [`APIResponse`](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/requests/APIResponse.html) object with JSON data, the HTTP response code, and the `Last-Modified` header.
2929

3030
The JSON data will need to be deserialized into an object model with a method in the [`Deserializer` class](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/Deserializer.html) before being used.
3131

@@ -48,6 +48,19 @@ Here is an example of continuously fetching the `Match` objects for the 2017 Mou
4848

4949
A list of object model classes and their getter methods for instance variables can be found [here](http://spencerng.github.io/blue-alliance-api-java-library/com/thebluealliance/api/v3/models/package-summary.html)
5050

51+
## Dependencies
52+
53+
You will need [Gson](https://github.com/google/gson) to use the released compiled TBA API JAR file in your project. Gson can be installed with [Maven](https://maven-badges.herokuapp.com/maven-central/com.google.code.gson/gson), via a [JAR file](http://repo1.maven.org/maven2/com/google/code/gson/gson/2.8.1/), or with Gradle if you include the following in your `build.gradle`
54+
55+
dependencies {
56+
compile 'com.google.code.gson:gson:2.2.4'
57+
}
58+
59+
Note that you will need Gradle to compile this repository's source code if you do not get Gson.
60+
61+
## Examples
62+
63+
5164
## Contact
5265

5366
Feel free to contact me at sng1488@gmail.com or create a pull request if you have any questions, fixes, or suggestions.

0 commit comments

Comments
 (0)