Update README.md

This commit is contained in:
Paldiu 2022-12-14 23:48:27 -06:00 committed by GitHub
parent 42aef3b955
commit 8f6b327d20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,10 +1,13 @@
# SimplexSS # 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) ![](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) A reactive non blocking api for scheduling runnable tasks (called services)
# Using SimplexSS in your project # 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. 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: Here's an example, in Gradle:
```gradle ```gradle
@ -17,8 +20,11 @@
``` ```
Then, you can add the dependency. Then, you can add the dependency.
The `groupId` is `com.github.SimplexDevelopment` The `groupId` is `com.github.SimplexDevelopment`
The `artifactId` is `SimplexSS` The `artifactId` is `SimplexSS`
The `version` is `1.0.1-SNAPSHOT` The `version` is `1.0.1-SNAPSHOT`
It is recommended you use either the Maven Shade Plugin, It is recommended you use either the Maven Shade Plugin,
@ -53,6 +59,7 @@
``` ```
Here is an example of the dependency, in Gradle: Here is an example of the dependency, in Gradle:
```gradle ```gradle
dependencies { dependencies {
shadow 'com.github.SimplexDevelopment:SimplexSS:1.0.1-SNAPSHOT' shadow 'com.github.SimplexDevelopment:SimplexSS:1.0.1-SNAPSHOT'