prepare release

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## unreleased
+## 2.0.0 - 2021-01-30
 ### Breaking
 * Java 11 or later required
 
@@ -10,9 +10,22 @@ All notable changes to this project will be documented in this file.
 * Client configuration with separate `UraClientConfiguration` class and builder
 * Client throws custom checked exception `UraClientException` instead of runtime exceptions on errors (#10)
 
+### Features
+* Configuration builder for client initialization (#9)
+* Configurable connect and read timeouts (#14)
+
 ### Fixed
 * Allow reopening an `AsyncUraTripReader` without raising an exception (#12)
 
+----
+
+## 1.3.1 - 2020-12-12
+### Fixed
+* Allow reopening an `AsyncUraTripReader` without raising an exception (#13)
+
+### Improvements
+* Dependency updates
+
 
 ## 1.3.0 - 2019-12-04
 ### Security

CONTRIBUTING.md

@@ -64,9 +64,10 @@ If you feel like you have to _briefly_ explain your changes, do it (for long exp
 
 **Example commit:**
 ```text
-Fix nasty bug from #1337
+Fix nasty bug (#1337)
 
-This example commit fixes the issue that some people write non-speaking commit messages like 'done magic'.
+This example commit fixes the issue that some people write non-speaking
+commit messages like 'done magic'.
 A short description is helpful sometimes.
 ```
 
@@ -106,7 +107,7 @@ Files ending with `Test.java` will be automatically included into the test suite
 
 ## Continuous Integration
 
-Automated tests are run using [Travis CI](https://travis-ci.org/stklcode/juraclient) for every commit including pull requests.
+Automated tests are run using [Travis CI](https://travis-ci.com/stklcode/juraclient) for every commit including pull requests.
 
 There is also a code quality analysis pushing results to [SonarCloud](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient).
 Keep in mind that the ruleset is not yet perfect, so not every minor issue has to be fixed immediately.

README.md

@@ -10,6 +10,14 @@ Java client for URA based public transport APIs.
 This client allows to simply connect any Java application to the public transport API to implement a monitor for the 
 local bus station or any other custom queries. API versions 1.x and 2.x are supported.
 
+## Supported versions
+Version 2.x requires Java 11 or later.
+It also contains some new features and allows configuration using a dedicated configuration object.
+
+Version 1.x requires Java 8 or later.
+This version currently receives security and bugfix updates.
+However, new features might not be backported.
+
 ## Usage Examples
 
 ### Initialization
@@ -21,6 +29,16 @@ UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk");
 UraClient ura = new UraClient("http://ivu.aseag.de", 
                               "interfaces/ura/instant_V2", 
                               "interfaces/ura/stream_V2");
+
+// Initialization with configuration builder (Client v2.x)
+UraClient ura = new UraClient(
+    UraClientConfiguration.forBaseURL("http://ura.example.com")
+                          .withInstantPath("interfaces/ura/instant_V2")
+                          .withStreamPath("interfaces/ura/stream_V2")
+                          .withConnectTimeout(Duration.ofSeconds(2))
+                          .withTimeout(Duration.ofSeconds(10))
+                          .build()
+);
 ```
 
 ### List Stops
@@ -63,7 +81,7 @@ List<Message> msgs = ura.forStop("100000")
 <dependency>
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>1.3.0</version>
+    <version>2.0.0</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>de.stklcode.pubtrans</groupId>
     <artifactId>juraclient</artifactId>
-    <version>2.0.0-SNAPSHOT</version>
+    <version>2.0.0</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>