Skip to content

Commit 3cb2dd0

Browse files
authored
Clean up README
1 parent dfbad7e commit 3cb2dd0

File tree

1 file changed

+30
-25
lines changed

1 file changed

+30
-25
lines changed

README.md

+30-25
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,12 @@ Glad you asked!
4747
- **[Built-in command cooldown handler](common/src/main/java/revxrsal/commands/annotation/Cooldown.java)**
4848

4949
## Getting Started
50-
Now, for the good part.
5150

52-
First, you'll need to add the JitPack repository, and then you're going to select which part of Lamp you're going to use.
53-
54-
If you for some reason want to use the whole project as dependency, you can use "com.github.Revxrsal" as the groupId (or group on Gradle), and only the name "Lamp" as the artifactId (or name on Gradle).
55-
But if you chose to use only one module or two, you have to use "com.github.Revxrsal.Lamp" as the groupId and "[the module that you want]" as the artifactId. Bellow, there are examples about Maven and Gradle that will help you get started.
51+
See available versions and modules below.
5652

5753
### Maven
58-
<details>
59-
<summary>pom.xml</summary>
54+
55+
**pom.xml**
6056

6157
``` xml
6258
<repositories>
@@ -67,38 +63,37 @@ But if you chose to use only one module or two, you have to use "com.github.Revx
6763
</repositories>
6864

6965
<dependencies>
70-
<!-- For the common module -->
66+
<!-- Required for all platforms -->
7167
<dependency>
7268
<groupId>com.github.Revxrsal.Lamp</groupId>
7369
<artifactId>common</artifactId>
7470
<version>[version]</version>
7571
</dependency>
7672

77-
<!-- For the bukkit module -->
73+
<!-- Add your specific platform module here -->
7874
<dependency>
7975
<groupId>com.github.Revxrsal.Lamp</groupId>
80-
<artifactId>bukkit</artifactId>
76+
<artifactId>[module]</artifactId>
8177
<version>[version]</version>
8278
</dependency>
8379
</dependencies>
8480
```
85-
</details>
8681

8782
### Gradle
88-
<details>
89-
<summary>build.gradle (Groovy)</summary>
90-
83+
84+
**build.gradle (Groovy)**
85+
9186
```groovy
9287
repositories {
9388
maven { url = 'https://jitpack.io' }
9489
}
9590
9691
dependencies {
97-
// For the common module
92+
// Required for all platforms
9893
implementation 'com.github.Revxrsal.Lamp:common:[version]'
9994
100-
// For the bukkit module
101-
implementation 'com.github.Revxrsal.Lamp:bukkit:[version]'
95+
// Add your specific platform module here
96+
implementation 'com.github.Revxrsal.Lamp:[module]:[version]'
10297
}
10398
10499
compileJava { // Preserve parameter names in the bytecode
@@ -111,23 +106,20 @@ compileKotlin { // optional: if you're using Kotlin
111106
kotlinOptions.javaParameters = true
112107
}
113108
```
114-
</details>
115-
116109

117-
<details>
118-
<summary>build.gradle.kts (Kotlin DSL)</summary>
110+
**build.gradle.kts (Kotlin DSL)**
119111

120112
```kotlin
121113
repositories {
122114
maven(url = "https://jitpack.io")
123115
}
124116

125117
dependencies {
126-
// For the common project
118+
// Required for all platforms
127119
implementation("com.github.Revxrsal.Lamp:common:[version]")
128120

129-
// For the bukkit module
130-
implementation("com.github.Revxrsal.Lamp:bukkit:[verison]")
121+
// Add your specific platform module here
122+
implementation("com.github.Revxrsal.Lamp:[module]:[verison]")
131123
}
132124

133125
compileJava { // Preserve parameter names in the bytecode
@@ -142,6 +134,19 @@ compileKotlin { // optional: if you're using Kotlin
142134
```
143135
</details>
144136

137+
**Latest stable version**
138+
139+
[![JitPack](https://jitpack.io/v/Revxrsal/Lamp.svg)](https://jitpack.io/#Revxrsal/Lamp)
140+
141+
**Available modules**:
142+
- `bukkit` for Bukkit/Spigot/Paper
143+
- `velocity` for [VelocityPowered](https://velocitypowered.com/)
144+
- `sponge` for [SpongePowered](https://spongepowered.org/)
145+
- `bungee` for [BungeeCord](https://www.spigotmc.org/wiki/bungeecord/)
146+
- `jda` for [Java Discord API (JDA)](https://github.com/DV8FromTheWorld/JDA)
147+
- `brigadier` for [Mojang Brigadier](https://github.com/Mojang/brigadier)
148+
- `cli` for building console applications
149+
145150
## Examples
146151

147152
**`/epicbans ban <player> <days> <reason>`**
@@ -204,7 +209,7 @@ Add `-silent` to make the ban silent
204209
**Terminate all nearby entities command**
205210

206211
```java
207-
@Command("killall")
212+
@Command("terminate")
208213
public void terminate(BukkitCommandActor sender, @Range(min = 1) int radius) {
209214
int killCount = 0;
210215
for (Entity target : sender.requirePlayer().getNearbyEntities(radius, radius, radius)) {

0 commit comments

Comments
 (0)