Skip to content

Commit e63f9e4

Browse files
Improve Readme (#9)
* Improve Readme - Added Gradle installation example - Added missing `color(String)` and `font(String)` methods * Apply suggestions from code review Co-authored-by: Peter Blood <rayzr522@gmail.com> Co-authored-by: Peter Blood <rayzr522@gmail.com>
1 parent d7a1c4b commit e63f9e4

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This library aims to completely replace [Fanciful](https://bukkit.org/threads/li
66

77
## Installation
88

9+
### Maven
910
For those of you using Maven, just add the following to your `pom.xml` file:
1011

1112
```xml
@@ -23,6 +24,23 @@ For those of you using Maven, just add the following to your `pom.xml` file:
2324
</dependency>
2425
```
2526

27+
### Gradle
28+
If you're using Gradle, add this to your `build.gradle` file:
29+
30+
```gradle
31+
repositories {
32+
maven { url 'https://rayzr.dev/repo/' }
33+
}
34+
```
35+
36+
```gradle
37+
dependencies {
38+
compile 'me.rayzr522:jsonmessage:1.2.0'
39+
}
40+
```
41+
42+
### Other
43+
2644
Otherwise, just drag n' drop the [single class file](https://github.com/Rayzr522/JSONMessage/blob/master/src/main/java/me/rayzr522/jsonmessage/JSONMessage.java) into your project.
2745
> If you are not yet using Maven, you should be. Really, you should. It's amazing.
2846
@@ -151,6 +169,8 @@ Method | Description
151169
`bar(int)` | Creates a horizontal divider bar of the given length
152170
`create(String)` | Creates a new JSONMessage with the given text as a starting point
153171
`color(ChatColor)` | Sets the color of the current message part
172+
`color(String)` | Same as `color(ChatColor)` but allows the usage of HEX colors in 1.16 and newer
173+
`font(String)` | Changes the font used for the text. Only usable in 1.16 and newer
154174
`newline()` | Inserts a newline. It really isn't necessary, you can just use `\n` if you want
155175
`style(ChatColor)` | Adds a style to the current message part
156176
`then(String)` | Adds another part to the message

0 commit comments

Comments
 (0)