Skip to content

Commit 39ee5aa

Browse files
committed
Updated documentation.
1 parent c6bbf7b commit 39ee5aa

File tree

3 files changed

+410
-6
lines changed

3 files changed

+410
-6
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,32 @@ Java API for OpenWeatherMap services.
55
* Current weather data
66
* 5 day / 3 hour forecast
77
* 16 day / daily forecast
8-
* UV Index(beta)
8+
* UV Index
99
* Air pollution(beta)
1010

1111
### Will be implemented later:
12-
TBD
12+
Global changes in API and more functionality.
1313

1414
### Maven coordinates:
1515

1616
```xml
1717
<dependency>
1818
<groupId>com.github.prominence</groupId>
1919
<artifactId>openweathermap-api</artifactId>
20-
<version>1.1</version>
20+
<version>1.2</version>
2121
</dependency>
2222
```
2323

2424
### Gradle coordinates:
2525

2626
```groovy
27-
compile('com.github.prominence:openweathermap-api:1.1')
27+
compile('com.github.prominence:openweathermap-api:1.2')
2828
```
2929

3030
### Documentation
3131
* [OpenWeatherMap Java API - 1.0](docs/Release_1.0.md)
3232
* [OpenWeatherMap Java API - 1.1](docs/Release_1.1.md)
33+
* [OpenWeatherMap Java API - 1.2](docs/Release_1.2.md)
3334
* [OpenWeatherMap Java API - SNAPSHOT](docs/SNAPSHOT.md)
3435

3536
### License

docs/Release_1.1.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Currently available methods:
3434
* `getHourlyForecastRequester()`
3535
* `getDailyForecastRequester()`
3636
* `getUltravioletIndexRequester()`
37+
* `getAirPollutionRequester()`
3738

3839
#### Current weather data
3940
First step is retrieving `WeatherRequester` instance:
@@ -271,7 +272,7 @@ UltravioletIndexRequester requester = openWeatherMapManager.getUltravioletIndexR
271272
```
272273
after you need to set coordinates and execute appropriate request:
273274
```
274-
DailyForecast forecastResponse = forecastRequester
275+
UltravioletIndex uvResponse = requester
275276
.setCoodrinates(55.33f, 24.27f)
276277
.getCurrentUVIndex();
277278
```
@@ -307,7 +308,7 @@ AirPollutionRequester requester = openWeatherMapManager.getAirPollutionRequester
307308
```
308309
after you need to set coordinates, time frame, date and execute appropriate request:
309310
```
310-
DailyForecast forecastResponse = forecastRequester
311+
AirPollution airPollutionResponse = forecastRequester
311312
.setCoordinates(0.0f, 10.0f)
312313
.setTimeFrame(TimeFrame.YEAR)
313314
.setDate(new Date())

0 commit comments

Comments
 (0)