Skip to content

Commit de38db3

Browse files
committed
Update README.
And a small misc edit.
1 parent 6919ad9 commit de38db3

2 files changed

Lines changed: 43 additions & 3 deletions

File tree

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,47 @@
11
# 📅 Tasks
22

33
[![](https://jitpack.io/v/community.leaf/tasks.svg)](https://jitpack.io/#community.leaf/tasks "Get maven artifacts on JitPack")
4-
[![](https://img.shields.io/badge/License-MPL--2.0-blue)](./LICENSE "Project license: MPL-2.0")
5-
[![](https://img.shields.io/badge/Java-11-orange)](# "This project targets Java 11")
4+
[![](https://img.shields.io/badge/License-MPL--2.0-blue)](./LICENSE "Project License: MPL-2.0")
5+
[![](https://img.shields.io/badge/Java-11-orange)](# "Java Version: 11")
6+
[![](https://img.shields.io/badge/View-Javadocs-%234D7A97)](https://javadoc.jitpack.io/community/leaf/tasks/tasks-parent/latest/javadoc/ "View Javadocs")
67

78
Build and schedule tasks.
9+
10+
## Maven
11+
12+
```xml
13+
<repositories>
14+
<repository>
15+
<id>jitpack.io</id>
16+
<url>https://jitpack.io</url>
17+
</repository>
18+
</repositories>
19+
```
20+
21+
```xml
22+
<dependency>
23+
<groupId>community.leaf.tasks</groupId>
24+
<artifactId><!--module--></artifactId>
25+
<version><!--release--></version>
26+
</dependency>
27+
```
28+
29+
### Modules
30+
31+
- **`tasks-bukkit`** → 🚰
32+
- Task scheduling for Bukkit plugins.
33+
- **`tasks-executor-service`** → ☕
34+
- Schedule platform-agnostic tasks with an executor service.
35+
36+
### Versions
37+
38+
Since we use JitPack to distribute this library, the versions available
39+
are the same as the `tags` found on the **releases page** of this repository.
40+
41+
### Shading
42+
43+
If you intend to shade this library, please consider **relocating** the packages
44+
to avoid potential conflicts with other projects. This library also utilizes
45+
nullness annotations, which may be undesirable in a shaded uber-jar. They can
46+
safely be excluded, and you are encouraged to do so.
47+

tasks-minecraft/src/main/java/community/leaf/tasks/minecraft/MinecraftTaskBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import community.leaf.tasks.ScheduledTaskBuilder;
1212
import community.leaf.tasks.TaskScheduler;
1313

14-
public interface MinecraftTaskBuilder<T>extends ScheduledTaskBuilder<T, MinecraftTaskBuilder<T>, Ticks<MinecraftTaskBuilder<T>>>
14+
public interface MinecraftTaskBuilder<T> extends ScheduledTaskBuilder<T, MinecraftTaskBuilder<T>, Ticks<MinecraftTaskBuilder<T>>>
1515
{
1616
static <T> MinecraftTaskBuilder<T> builder(TaskScheduler<T> scheduler, Concurrency concurrency)
1717
{

0 commit comments

Comments
 (0)