From 276c12abc438288d442ed8bc0c112b5adb0b39f7 Mon Sep 17 00:00:00 2001 From: Stefan Kalscheuer Date: Sat, 2 Oct 2021 15:25:52 +0200 Subject: [PATCH] readme++ --- .drone.yml | 4 ++-- CONTRIBUTING.md | 2 +- README.md | 16 ++++++++-------- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.drone.yml b/.drone.yml index 02c4e40..9294655 100644 --- a/.drone.yml +++ b/.drone.yml @@ -6,7 +6,7 @@ steps: - name: test image: maven:3-openjdk-11 commands: - - mvn clean test + - mvn -B clean test --- kind: pipeline @@ -17,4 +17,4 @@ steps: - name: test image: maven:3-openjdk-17 commands: - - mvn clean test + - mvn -B clean test diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9064352..4d88e59 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,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.com/stklcode/juraclient) for every commit including pull requests. +Automated tests are run using [GitHub Actions](https://github.com/stklcode/juraclient/actions/) 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. diff --git a/README.md b/README.md index 9a48f00..ab97f71 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # jURAclient -[![Build Status](https://travis-ci.com/stklcode/juraclient.svg?branch=master)](https://travis-ci.com/stklcode/juraclient) +[![Build Status](https://github.com/stklcode/juraclient/actions/workflows/ci.yml/badge.svg)](https://github.com/stklcode/juraclient/actions/workflows/ci.yml) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.pubtrans%3Ajuraclient&metric=alert_status)](https://sonarcloud.io/dashboard?id=de.stklcode.pubtrans%3Ajuraclient) [![Javadocs](https://www.javadoc.io/badge/de.stklcode.pubtrans/juraclient.svg)](https://www.javadoc.io/doc/de.stklcode.pubtrans/juraclient) [![Maven Central](https://img.shields.io/maven-central/v/de.stklcode.pubtrans/juraclient.svg)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.stklcode.pubtrans%22%20AND%20a%3A%22juraclient%22) @@ -22,17 +22,17 @@ However, new features might not be backported. ### Initialization ```java -// Instantiate the client (e.g. using the TFL API) -UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk"); +// Instantiate the client. +UraClient ura = new UraClient("https://ura.example.com"); -// Initialize the API with non-standard endpoints (e.g. ASEAG with API V2) -UraClient ura = new UraClient("http://ivu.aseag.de", +// Initialize the API with non-standard endpoints. +UraClient ura = new UraClient("https://ura.example.com", "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") + UraClientConfiguration.forBaseURL("https://ura.example.com") .withInstantPath("interfaces/ura/instant_V2") .withStreamPath("interfaces/ura/stream_V2") .withConnectTimeout(Duration.ofSeconds(2)) @@ -81,10 +81,10 @@ List msgs = ura.forStop("100000") de.stklcode.pubtrans juraclient - 2.0.0 + 2.0.1 ``` ## License -The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0). +The project is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).