README.adoc

sirloin-jvmlib

Table of Contents

• Overview
• Requirements
• Installation
  • Gradle
  • Maven

Overview

Collection of JVM library logic that the Sirloin software development team is currently using.

Requirements

• Kotlin 1.5.31

• OpenJDK 17 or compatible

Installation

Gradle

1. Add jitpack.io maven repository

   allprojects {
     repositories {
       // ...
       maven { url 'https://jitpack.io' }
     }
   }

2. Declare dependencies

   dependencies {
     def libSirloinJvmLib = "1.2.3"
   
     implementation "com.github.sirloin-dev.sirloin-jvmlib:sirloin-jvmlib-annotation:$libSirloinJvmLib"
     implementation "com.github.sirloin-dev.sirloin-jvmlib:sirloin-jvmlib-crypto:$libSirloinJvmLib"
     implementation "com.github.sirloin-dev.sirloin-jvmlib:sirloin-jvmlib-net:$libSirloinJvmLib"
     implementation "com.github.sirloin-dev.sirloin-jvmlib:sirloin-jvmlib-text:$libSirloinJvmLib"
     implementation "com.github.sirloin-dev.sirloin-jvmlib:sirloin-jvmlib-time:$libSirloinJvmLib"
     implementation "com.github.sirloin-dev.sirloin-jvmlib:sirloin-jvmlib-util:$libSirloinJvmLib"
   
     // Test helpers: Better not to include this as main dependency
     testImplementation "com.github.sirloin-dev.sirloin-jvmlib:sirloin-jvmlib-test:$libSirloinJvmLib"
   }

Maven

1. Add jitpack.io maven repository

   <repositories>
     <repository>
       <id>jitpack.io</id>
         <url>https://jitpack.io</url>
     </repository>
   </repositories>

2. Declare dependencies

   <dependencies>
     <dependency>
       <groupId>com.github.sirloin-dev.sirloin-jvmlib</groupId>
       <artifactId>sirloin-jvmlib-annotation</artifactId>
       <version>1.2.3</version>
     </dependency>
   
     <dependency>
       <groupId>com.github.sirloin-dev.sirloin-jvmlib</groupId>
       <artifactId>sirloin-jvmlib-crypto</artifactId>
       <version>1.2.3</version>
     </dependency>
   
     <dependency>
       <groupId>com.github.sirloin-dev.sirloin-jvmlib</groupId>
       <artifactId>sirloin-jvmlib-net</artifactId>
       <version>1.2.3</version>
     </dependency>
   
     <dependency>
       <groupId>com.github.sirloin-dev.sirloin-jvmlib</groupId>
       <artifactId>sirloin-jvmlib-text</artifactId>
       <version>1.2.3</version>
     </dependency>
   
     <dependency>
       <groupId>com.github.sirloin-dev.sirloin-jvmlib</groupId>
       <artifactId>sirloin-jvmlib-time</artifactId>
       <version>1.2.3</version>
     </dependency>
   
     <dependency>
       <groupId>com.github.sirloin-dev.sirloin-jvmlib</groupId>
       <artifactId>sirloin-jvmlib-util</artifactId>
       <version>1.2.3</version>
     </dependency>
   
     <!-- Test helpers: Better not to include this as main dependency -->
     <dependency>
       <groupId>com.github.sirloin-dev.sirloin-jvmlib</groupId>
       <artifactId>sirloin-jvmlib-test</artifactId>
       <version>1.2.3</version>
       <scope>test</scope>
     </dependency>
   </dependencies>