Skip to content

Commit f6513c2

Browse files
committed
Update README
1 parent b49f3c0 commit f6513c2

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

.github/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
<div align="center">
44

5-
[![Build](https://github.com/Despical/CommandFramework/actions/workflows/build-commandframework.yml/badge.svg)](https://github.com/Despical/CommandFramework/actions/workflows/build-commandframework.yml)
5+
[![](https://github.com/Despical/CommandFramework/actions/workflows/build-commandframework.yml/badge.svg)](https://github.com/Despical/CommandFramework/actions/workflows/build-commandframework.yml)
66
[![](https://jitpack.io/v/Despical/CommandFramework.svg)](https://jitpack.io/#Despical/CommandFramework)
77
[![](https://img.shields.io/badge/JavaDocs-latest-lime.svg)](https://javadoc.jitpack.io/com/github/Despical/CommandFramework/latest/javadoc/index.html)
8-
[![Support](https://img.shields.io/badge/Patreon-Support-lime.svg?logo=Patreon)](https://www.patreon.com/despical)
8+
[![](https://img.shields.io/badge/Patreon-Support-lime.svg?logo=Patreon)](https://www.patreon.com/despical)
9+
[![](https://img.shields.io/badge/BuyMeACoffee-Support-lime.svg?logo=BuyMeACoffee)](https://www.buymeacoffee.com/despical)
910

1011
This framework is very lightweight annotation based command system that works similar to Bukkit's event system. It removes the necessity to
1112
add commands to your plugin.yml but will still allow you to set command usage, description, permission, aliases, sender type, cooldown, minimum
@@ -86,7 +87,7 @@ public class ExampleClass extends JavaPlugin {
8687
String label = arguments.getLabel(), arg = arguments.getArgument(0);
8788

8889
// StringMatcher is an external class from Despical's Commons library which is not in this framework
89-
ListStringMatcher.Match > matches = StringMatcher.match(arg, commandFramework.getCommands().stream().map(cmd -> cmd.name().replace(label + ".", "")).collect(Collectors.toList()));
90+
List<StringMatcher.Match > matches = StringMatcher.match(arg, commandFramework.getCommands().stream().map(cmd -> cmd.name().replace(label + ".", "")).collect(Collectors.toList()));
9091

9192
if (!matches.isEmpty()) {
9293
arguments.sendMessage("Did you mean %command%?".replace("%command%", label + " " + matches.get(0).getMatch()));
@@ -129,7 +130,7 @@ public class ExampleClass extends JavaPlugin {
129130
name = "nocommandargs"
130131
)
131132
public void noCommandArgsTest() {
132-
Logger.getLogger(this.getClass().getSimpleName()).info("This command is annotated with @NoCommandArguments to run without required parameters.");
133+
Logger.getLogger(this.getClass().getSimpleName()).info("This command is running without any parameters.");
133134
}
134135

135136
@Command(
@@ -147,8 +148,7 @@ public class ExampleClass extends JavaPlugin {
147148
name = "example",
148149
aliases = {"firstAlias", "secondAlias"}
149150
)
150-
public List<String> exampleCommandCompletion(CommandArguments arguments) {
151-
// And you've created a tab completion for the command above
151+
public List<String> exampleCommandCompletion(/*CommandArguments arguments*/ /*no need to use in this case which is also supported*/) {
152152
return Arrays.asList("first", "second", "third");
153153
}
154154
}
@@ -182,7 +182,8 @@ You can learn more about contributing via GitHub in [contribution guidelines](..
182182
To build this project from source code, run the following from Git Bash:
183183
```
184184
git clone https://www.github.com/Despical/CommandFramework && cd CommandFramework
185-
mvn clean package -Dmaven.javadoc.skip=true
185+
mvn clean package -DskipTests -Dmaven.javadoc.skip=true
186186
```
187187

188-
> **Note** Don't forget to install Maven before building.
188+
> [!IMPORTANT]
189+
> Don't forget to install Maven before building.

0 commit comments

Comments
 (0)