Skip to content

Commit d8d681e

Browse files
committed
🔨 build: update dependencies, improve README.md
1 parent c86bb01 commit d8d681e

2 files changed

Lines changed: 19 additions & 23 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,11 @@ An optimized and lightweight toolkit of flexible common utilities for developing
1616

1717
## Installation
1818

19-
1. Add the library as a JitPack dependency via a build automation tool that you're using, such as Maven, Gradle, sbt,
20-
etc. See all releases, snapshots and guides at
19+
1. Add the library as a JitPack dependency via a build automation tool that you're using, such as Maven or Gradle. See all releases, snapshots and guides at
2120
the [official JitPack website of this project](https://jitpack.io/#CosimoTiger/plugin-utilities).
2221

2322
2. Shade the dependency library using JAR minimization to exclude unused features from being compiled with your plugin,
24-
which will decrease the file size impact of the dependency while keeping your plugin lightweight. Even though the
25-
dependency is small, this process ensures efficient packaging by eliminating unnecessary code.
23+
which will decrease the file size impact of the dependency, even though it's already relatively small.
2624

2725
Here's how you can configure it using Maven Shade Plugin, by adding inside Maven `<plugins>...</plugins>`:
2826

@@ -40,8 +38,8 @@ An optimized and lightweight toolkit of flexible common utilities for developing
4038
<configuration>
4139
<minimizeJar>true</minimizeJar>
4240
<artifactSet>
43-
<!-- Replace the "Tag" with the latest release version -->
44-
<includes>com.github.CosimoTiger:plugin-utilities:Tag</includes>
41+
<!-- Replace the VERSION with the latest release version -->
42+
<includes>com.github.CosimoTiger:plugin-utilities:VERSION</includes>
4543
</artifactSet>
4644
</configuration>
4745
</execution>
@@ -66,8 +64,8 @@ An optimized and lightweight toolkit of flexible common utilities for developing
6664
}
6765

6866
dependencies {
69-
// Replace the "Tag" with the latest release version
70-
include dependency('com.github.CosimoTiger:plugin-utilities:Tag')
67+
// Replace the VERSION with the latest release version
68+
include dependency('com.github.CosimoTiger:plugin-utilities:VERSION')
7169
}
7270
}
7371
```
@@ -85,7 +83,7 @@ An optimized and lightweight toolkit of flexible common utilities for developing
8583
public void onEnable() {
8684
MenuManager.setInstance(new MenuManager(this));
8785

88-
final var config = new YamlFile(this, "command-config.yml").reloadFile().getMemory();
86+
final var config = new YamlFile(this, "messages.yml").reloadFile().getMemory();
8987

9088
getCommand("example").setExecutor(new ExampleCommand(config.getConfigurationSection("commands.example")));
9189
}
@@ -97,6 +95,8 @@ An optimized and lightweight toolkit of flexible common utilities for developing
9795
We welcome contributions from the community, through forking or opening an issue. They should be in line with the
9896
project's main goals: optimized code that benefits everyone.
9997
98+
**How to build the project:** `mvn clean package`
99+
100100
## License
101101
102102
This project is licensed under the [MIT License](./LICENSE).

pom.xml

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>com.cosimo</groupId>
88
<artifactId>plugin-utilities</artifactId>
9-
<version>1.0.0-beta.1</version>
9+
<version>1.0.0-beta.3</version>
1010
<name>PluginUtilities</name>
1111
<url>https://github.com/CosimoTiger/plugin-utilities</url>
1212
<description>A library with many utilities that help with developing Spigot plugins.</description>
@@ -17,9 +17,8 @@
1717
<finalName>${project.artifactId}-${project.version}</finalName>
1818
<plugins>
1919
<plugin>
20-
<groupId>org.apache.maven.plugins</groupId>
2120
<artifactId>maven-compiler-plugin</artifactId>
22-
<version>3.13.0</version>
21+
<version>3.14.0</version>
2322
<configuration>
2423
<release>21</release>
2524
<annotationProcessorPaths>
@@ -32,7 +31,6 @@
3231
</configuration>
3332
</plugin>
3433
<plugin>
35-
<groupId>org.apache.maven.plugins</groupId>
3634
<artifactId>maven-source-plugin</artifactId>
3735
<version>3.3.1</version>
3836
<executions>
@@ -45,9 +43,8 @@
4543
</executions>
4644
</plugin>
4745
<plugin>
48-
<groupId>org.apache.maven.plugins</groupId>
4946
<artifactId>maven-javadoc-plugin</artifactId>
50-
<version>3.11.2</version>
47+
<version>3.11.3</version>
5148
<configuration>
5249
<doclint>all,-missing</doclint>
5350
</configuration>
@@ -61,9 +58,8 @@
6158
</executions>
6259
</plugin>
6360
<plugin>
64-
<groupId>org.apache.maven.plugins</groupId>
6561
<artifactId>maven-surefire-plugin</artifactId>
66-
<version>3.5.2</version>
62+
<version>3.5.3</version>
6763
</plugin>
6864
</plugins>
6965
</build>
@@ -84,36 +80,36 @@
8480
<dependency>
8581
<groupId>org.spigotmc</groupId>
8682
<artifactId>spigot-api</artifactId>
87-
<version>1.21.4-R0.1-SNAPSHOT</version>
83+
<version>1.21.8-R0.1-SNAPSHOT</version>
8884
<scope>provided</scope>
8985
</dependency>
9086
<dependency>
9187
<groupId>org.jetbrains</groupId>
9288
<artifactId>annotations</artifactId>
93-
<version>26.0.1</version>
89+
<version>26.0.2</version>
9490
<scope>provided</scope>
9591
</dependency>
9692
<dependency>
9793
<groupId>org.projectlombok</groupId>
9894
<artifactId>lombok</artifactId>
99-
<version>1.18.36</version>
95+
<version>1.18.38</version>
10096
</dependency>
10197
<dependency>
10298
<groupId>org.junit.jupiter</groupId>
10399
<artifactId>junit-jupiter-engine</artifactId>
104-
<version>5.11.4</version>
100+
<version>5.13.4</version>
105101
<scope>test</scope>
106102
</dependency>
107103
<dependency>
108104
<groupId>org.junit.jupiter</groupId>
109105
<artifactId>junit-jupiter-params</artifactId>
110-
<version>5.11.2</version>
106+
<version>5.13.4</version>
111107
<scope>test</scope>
112108
</dependency>
113109
<dependency>
114110
<groupId>org.mockito</groupId>
115111
<artifactId>mockito-core</artifactId>
116-
<version>5.14.2</version>
112+
<version>5.19.0</version>
117113
<scope>test</scope>
118114
</dependency>
119115
</dependencies>

0 commit comments

Comments
 (0)