Merge pull request #7 from fingerprintjs/jitpack-docs

Jitpack docs
fingerprintjs · Feb 24, 2023 · 3bf1172 · 3bf1172
2 parents b8efe02 + e3e4d5e
commit 3bf1172
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,9 @@
     </a>
 </p>
 <p align="center">
+    <a href="https://jitpack.io/#fingerprintjs/fingerprint-pro-server-api-java-sdk">
+        <img src="https://jitpack.io/v/fingerprintjs/fingerprint-pro-server-api-java-sdk.svg" alt="Jitpack Release" />
+    </a>
     <a href="https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/actions/workflows/release.yml">
         <img src="https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/actions/workflows/release.yml/badge.svg" alt="CI badge" />
     </a>
@@ -44,12 +47,20 @@ Building the API client library requires:
 
 Add this dependency to your project's POM:
 
+```xml
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+```
+
 ```xml
 <dependency>
-  <groupId>com.fingerprint</groupId>
-  <artifactId>fingerprint-pro-server-api-sdk</artifactId>
-  <version>1.0.0</version>
-  <scope>compile</scope>
+  <groupId>com.github.fingerprintjs</groupId>
+  <artifactId>fingerprint-pro-server-api-java-sdk</artifactId>
+  <version>v1.0.0</version>
 </dependency>
 ```
 
@@ -59,12 +70,11 @@ Add this dependency to your project's build file:
 
 ```groovy
   repositories {
-    mavenCentral()     // Needed if the 'fingerprint-pro-server-api-sdk' jar has been published to maven central.
-    mavenLocal()       // Needed if the 'fingerprint-pro-server-api-sdk' jar has been published to the local maven repo.
+     maven { url 'https://jitpack.io' }
   }
 
   dependencies {
-     implementation "com.fingerprint:fingerprint-pro-server-api-sdk:1.0.0"
+     implementation "com.github.fingerprintjs:fingerprint-pro-server-api-java-sdk:v1.0.0"
   }
 ```
 

diff --git a/template/README.mustache b/template/README.mustache
@@ -8,6 +8,9 @@
     </a>
 </p>
 <p align="center">
+    <a href="https://jitpack.io/#fingerprintjs/fingerprint-pro-server-api-java-sdk">
+        <img src="https://jitpack.io/v/fingerprintjs/fingerprint-pro-server-api-java-sdk.svg" alt="Jitpack Release" />
+    </a>
     <a href="https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/actions/workflows/release.yml">
         <img src="https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/actions/workflows/release.yml/badge.svg" alt="CI badge" />
     </a>
@@ -49,12 +52,20 @@ Building the API client library requires:
 
 Add this dependency to your project's POM:
 
+```xml
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+```
+
 ```xml
 <dependency>
-  <groupId>{{{groupId}}}</groupId>
-  <artifactId>{{{artifactId}}}</artifactId>
-  <version>{{{artifactVersion}}}</version>
-  <scope>compile</scope>
+  <groupId>com.github.fingerprintjs</groupId>
+  <artifactId>fingerprint-pro-server-api-java-sdk</artifactId>
+  <version>v{{{artifactVersion}}}</version>
 </dependency>
 ```
 
@@ -64,12 +75,11 @@ Add this dependency to your project's build file:
 
 ```groovy
   repositories {
-    mavenCentral()     // Needed if the '{{{artifactId}}}' jar has been published to maven central.
-    mavenLocal()       // Needed if the '{{{artifactId}}}' jar has been published to the local maven repo.
+     maven { url 'https://jitpack.io' }
   }
 
   dependencies {
-     implementation "{{{groupId}}}:{{{artifactId}}}:{{{artifactVersion}}}"
+     implementation "com.github.fingerprintjs:fingerprint-pro-server-api-java-sdk:v{{{artifactVersion}}}"
   }
 ```