From c090007c09bf10f34e22907a3f8b40a33baec68e Mon Sep 17 00:00:00 2001 From: Orkun Date: Thu, 7 Dec 2023 12:47:04 +0300 Subject: [PATCH 1/3] docs(readme): comply new policy template --- README.md | 16 +++++++++++----- template/README.mustache | 23 ++++++++++++----------- 2 files changed, 23 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 59c83b2..70faff0 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,11 @@ ## Requirements -Building the API client library requires: +The following versions of Java are supported -1. Java 1.8+ -2. Maven (3.8.3+)/Gradle (7.2+) +- Java 1.8 +- Java 8 +- Java 11 ## Installation @@ -310,7 +311,12 @@ Authentication schemes defined for the API: It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues. -## Author +## Support -support@fingerprint.com +To report problems, ask questions or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/issues). +If you need private support, you can email us at [oss-support@fingerprint.com](mailto:oss-support@fingerprint.com). + +## License + +This project is licensed under the [MIT License](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/blob/main/LICENSE). diff --git a/template/README.mustache b/template/README.mustache index 78a2cd8..0f20875 100644 --- a/template/README.mustache +++ b/template/README.mustache @@ -36,15 +36,11 @@ ## Requirements -Building the API client library requires: +The following versions of Java are supported -1. Java 1.8+ -{{#jersey2}} -2. Maven (3.8.3+)/Gradle (7.2+) -{{/jersey2}} -{{^jersey2}} -2. Maven/Gradle -{{/jersey2}} +- Java 1.8 +- Java 8 +- Java 11 ## Installation @@ -247,7 +243,12 @@ Class | Method | HTTP request | Description It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues. -## Author +## Support + +To report problems, ask questions or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/issues). +If you need private support, you can email us at [oss-support@fingerprint.com](mailto:oss-support@fingerprint.com). + + +## License -{{#apiInfo}}{{#apis}}{{#-last}}{{infoEmail}} -{{/-last}}{{/apis}}{{/apiInfo}} +This project is licensed under the [MIT License](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/blob/main/LICENSE). From 00476fea400acc9727432276abb8e6586d9a66b5 Mon Sep 17 00:00:00 2001 From: Orkun Date: Tue, 12 Dec 2023 12:16:13 +0300 Subject: [PATCH 2/3] docs(readme): description & package manager versions --- README.md | 10 +++++++++- template/README.mustache | 10 +++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 70faff0..5f6caee 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,21 @@

# Fingerprint Pro Server API Java SDK -**Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro.** + +**Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. +It can be used for data exports, decision-making, and data analysis scenarios. +Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.** *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* ## Requirements +The following versions of Gradle/Maven are supported + +- Maven (3.8.3+) +- Gradle (7.2+) + The following versions of Java are supported - Java 1.8 diff --git a/template/README.mustache b/template/README.mustache index 0f20875..aac4936 100644 --- a/template/README.mustache +++ b/template/README.mustache @@ -29,13 +29,21 @@

# Fingerprint Pro Server API Java SDK -**Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro.** + +**Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. +It can be used for data exports, decision-making, and data analysis scenarios. +Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.** *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* ## Requirements +The following versions of Gradle/Maven are supported + +- Maven (3.8.3+) +- Gradle (7.2+) + The following versions of Java are supported - Java 1.8 From acb8e6390056d7197b62accaa9e0f2643743ce47 Mon Sep 17 00:00:00 2001 From: Orkun Date: Wed, 20 Dec 2023 11:30:35 +0300 Subject: [PATCH 3/3] docs(readme): update description using guidelines Co-authored-by: Juraj Uhlar --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 5f6caee..8f69fba 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,7 @@ # Fingerprint Pro Server API Java SDK -**Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. -It can be used for data exports, decision-making, and data analysis scenarios. -Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.** +[Fingerprint](https://fingerprint.com/) is a device intelligence platform offering 99.5% accurate visitor identification. The Fingerprint Server Java SDK is an easy way to interact with the Fingerprint [Server API](https://dev.fingerprint.com/reference/pro-server-api) from your Java application. You can retrieve visitor history or individual identification events. *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*