From 05a3064285807e676f38b77f77dbfccc85597e5d Mon Sep 17 00:00:00 2001 From: tommyskeff Date: Tue, 21 Nov 2023 20:45:58 +0000 Subject: [PATCH] Add dependency information --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/README.md b/README.md index b92d40c..c77f773 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,70 @@ Futur4J is a powerful and intuitive open-source Java library that simplifies asynchronous task scheduling, inspired by the concept of JavaScript promises. +## Dependency +The Futur4J project is composed of multiple modules. It is required to include the `futur-api` module, and the other modules depend on it at runtime, however the others are optional and dependent on your use case. +### Gradle +```gradle +repositories { + maven { + url 'https://repo.tommyjs.dev/repository/maven-releases/' + } +} + +dependencies { + compile 'dev.tommyjs:futur-api:1.0.0' + compile 'dev.tommyjs:futur-standalone:1.0.0' + compile 'dev.tommyjs:futur-reactor:1.0.0' + compile 'dev.tommyjs:futur-reactive-streams:1.0.0' +} +``` +### Gradle DSL +```dsl +repositories { + maven("https://repo.tommyjs.dev/repository/maven-releases/") +} + +dependencies { + implementation("dev.tommyjs:futur-api:1.0.0") + implementation("dev.tommyjs:futur-standalone:1.0.0") + implementation("dev.tommyjs:futur-reactor:1.0.0") + implementation("dev.tommyjs:futur-reactive-streams:1.0.0") +} +``` +### Maven +```xml + + + tommyjs-repo + https://repo.tommyjs.dev/repository/maven-releases/ + + + + + + dev.tommyjs + futur-api + 1.0.0 + + + dev.tommyjs + futur-standalone + 1.0.0 + + + dev.tommyjs + futur-reactor + 1.0.0 + + + dev.tommyjs + futur-reactive-streams + 1.0.0 + + +``` + + ## Getting started Futur4J uses an underlying `Scheduler` instance to power both synchronous and asynchronous task execution.