Skip to content

Commit 395d2cf

Browse files
Full reworking of README.md, Updating JavaDoc link
1 parent 045ddbd commit 395d2cf

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# RedUtilities
22

3-
RedUtilities is a small Java toolkit for Minecraft plugin development. The preparation of the methods was designed for the application of RedstoneWorld plugins, but can be useful with any pattern.
3+
RedUtilities is a small Java toolkit for **Minecraft PaperMC plugin development**. The preparation of the methods was designed for the application of [RedstoneWorld](https://redstoneworld.de) plugins, but can be useful with any pattern.
4+
5+
[![Developed by RedstoneWorld](https://redstoneworld.de/bilder/kooperation/RedstoneWorld-Logo_small.png)](https://redstoneworld.de)
46

57
# Development with RedUtilities
68

@@ -13,11 +15,20 @@ RedUtilities is a small Java toolkit for Minecraft plugin development. The prepa
1315
Add the following to your Java project `pom.xml` file:
1416

1517
```xml
16-
<dependency>
18+
<repositories>
19+
<repository>
20+
<id>redstoneworld-RedUtilities</id>
21+
<url>https://dl.cloudsmith.io/public/redstoneworld/RedUtilities/maven/</url>
22+
</repository>
23+
</repositories>
24+
25+
<repositories>
26+
<dependency>
1727
<groupId>de.redstoneworld.redutilities</groupId>
1828
<artifactId>redutilities</artifactId>
1929
<version>%version%</version>
20-
</dependency>
30+
</dependency>
31+
</repositories>
2132
```
2233

2334
## Usage with Gradle
@@ -26,17 +37,17 @@ Add the following to your Java project `build.gradle` file:
2637

2738
```text
2839
repositories {
29-
maven {
30-
name = 'cloudsmith'
31-
url = 'https://dl.cloudsmith.io/public/redstoneworld/RedUtilities/maven/'
32-
}
40+
maven {
41+
url "https://dl.cloudsmith.io/public/redstoneworld/RedUtilities/maven/"
42+
}
3343
}
3444
3545
dependencies {
36-
implementation 'de.redstoneworld.redutilities:redutilities:%version%'
46+
implementation 'de.redstoneworld.redutilities:redutilities:%version%'
3747
}
3848
```
3949

40-
# Javadoc
50+
# Documentation
4151

42-
You can find the Javadoc of RedUtilities [here](https://redstoneworld.github.io/RedUtilities/javadoc).
52+
- [Java-Doc](https://redstoneworld.github.io/RedUtilities/apidocs)
53+
- [Project Dependencies](https://redstoneworld.github.io/RedUtilities/dependencies.html)

0 commit comments

Comments
 (0)