From 8f6b327d20e42c5157693da44dce5a05676c1dda Mon Sep 17 00:00:00 2001 From: Paldiu Date: Wed, 14 Dec 2022 23:48:27 -0600 Subject: [PATCH] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 8b4ccc8..374660e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # SimplexSS + ![](https://img.shields.io/github/workflow/status/SimplexDevelopment/SimplexSS/CodeQL/main) ![](https://img.shields.io/github/v/release/SimplexDevelopment/SimplexSS?include_prereleases) ![](https://img.shields.io/github/license/SimplexDevelopment/SimplexSS) !(https://img.shields.io/github/issues/SimplexDevelopment/SimplexSS) ![](https://img.shields.io/github/stars/SimplexDevelopment/SimplexSS?style=social) ![](https://img.shields.io/github/forks/SimplexDevelopment/SimplexSS?style=social) ![](https://img.shields.io/github/languages/top/SimplexDevelopment/SimplexSS) A reactive non blocking api for scheduling runnable tasks (called services) # Using SimplexSS in your project + In order to use SimplexSS in your project, you need to add the jitpack repository to your build.gradle or pom.xml file. + Here's an example, in Gradle: ```gradle @@ -17,8 +20,11 @@ ``` Then, you can add the dependency. + The `groupId` is `com.github.SimplexDevelopment` + The `artifactId` is `SimplexSS` + The `version` is `1.0.1-SNAPSHOT` It is recommended you use either the Maven Shade Plugin, @@ -53,6 +59,7 @@ ``` Here is an example of the dependency, in Gradle: + ```gradle dependencies { shadow 'com.github.SimplexDevelopment:SimplexSS:1.0.1-SNAPSHOT'