Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): comply new policy template INTER-282 #23

Merged
merged 3 commits into from
Dec 21, 2023
Merged

docs(readme): comply new policy template INTER-282 #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c090007
docs(readme): comply new policy template
Orkuncakilkaya Dec 7, 2023
00476fe
docs(readme): description & package manager versions
Orkuncakilkaya Dec 12, 2023
acb8e63
docs(readme): update description using guidelines
Orkuncakilkaya Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,24 @@
</p>

# Fingerprint Pro Server API Java SDK
**Fingerprint Pro Server API provides a way for validating visitors’ data issued by Fingerprint Pro.**

[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)*

Orkuncakilkaya marked this conversation as resolved.
Show resolved Hide resolved
## Requirements

Building the API client library requires:
The following versions of Gradle/Maven are supported

- Maven (3.8.3+)
- Gradle (7.2+)

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
Orkuncakilkaya marked this conversation as resolved.
Show resolved Hide resolved

## Installation

Expand Down Expand Up @@ -310,7 +317,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

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 [[email protected]](mailto:[email protected]).


[email protected]
## License

This project is licensed under the [MIT License](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/blob/main/LICENSE).
33 changes: 21 additions & 12 deletions template/README.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,26 @@
</p>

# 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

Building the API client library requires:
The following versions of Gradle/Maven are supported

1. Java 1.8+
{{#jersey2}}
2. Maven (3.8.3+)/Gradle (7.2+)
{{/jersey2}}
{{^jersey2}}
2. Maven/Gradle
{{/jersey2}}
- Maven (3.8.3+)
- Gradle (7.2+)

The following versions of Java are supported

- Java 1.8
- Java 8
- Java 11

## Installation

Expand Down Expand Up @@ -247,7 +251,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 [[email protected]](mailto:[email protected]).


## 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).
Loading