Skip to content

Commit b371b85

Browse files
committed
Updated README.md
1 parent 94686e1 commit b371b85

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
This library simplifies color management while allowing developers to build beautifully formatted text with ease!
66

7+
![Thumbnail](https://i.imgur.com/God4ZAt.png)
8+
79
## ✨ Features
810

911
- 🎨 **Hex and Legacy Color Code Support**
@@ -18,6 +20,9 @@ This library simplifies color management while allowing developers to build beau
1820

1921
## 🚀 Getting Started
2022

23+
> [!IMPORTANT]
24+
> While MatrixColorAPI is designed to work with all Minecraft server software, it has currently been extensively tested only on Bukkit platforms. We encourage users on other platforms to try it out and report any issues they encounter. Your feedback is crucial in making MatrixColorAPI universally compatible!
25+
2126
### Installation
2227

2328
![API Version](https://img.shields.io/jitpack/v/MatrixCreations/MatrixColorAPI.svg?color=512BD4&label=API%20Version&style=for-the-badge)
@@ -35,7 +40,7 @@ MatrixColorAPI is hosted on [Jitpack](https://jitpack.io), making it easy to int
3540
2. **Add the dependency** in your `dependencies` block:
3641
```gradle
3742
dependencies {
38-
implementation 'com.github.MatrixCreations:MatrixColorAPI:v1.0.5'
43+
implementation 'com.github.MatrixCreations:MatrixColorAPI:v1.0.6'
3944
}
4045
```
4146

@@ -53,7 +58,7 @@ MatrixColorAPI is hosted on [Jitpack](https://jitpack.io), making it easy to int
5358
<dependency>
5459
<groupId>com.github.MatrixCreations</groupId>
5560
<artifactId>MatrixColorAPI</artifactId>
56-
<version>v1.0.5</version>
61+
<version>v1.0.6</version>
5762
</dependency>
5863
```
5964

@@ -66,30 +71,38 @@ MatrixColorAPI is hosted on [Jitpack](https://jitpack.io), making it easy to int
6671

6772
- **Solid Color Example:**
6873

74+
![Solid Color Example](https://media.discordapp.net/attachments/1262415791731511347/1291383818502279218/image.png?ex=66ffe667&is=66fe94e7&hm=8cbe3b951c6b0cd7eee1b9edb7718f81b75c46f8e72388746b1fc1ed0da39c1e&=&format=webp&quality=lossless)
75+
6976
```java
7077
String text = "<SOLID:#FFD700>This is yellow text";
71-
String processed = ColorUtils.process(text);
78+
String processed = MatrixColorAPI.process(text);
7279
```
7380

7481
- **Gradient Example:**
7582

83+
![Gradient Color Example](https://media.discordapp.net/attachments/1262415791731511347/1291384051160055869/image.png?ex=66ffe69e&is=66fe951e&hm=ba7d6c4748241b8e989249e2cf7818fe41a2768a61a58753fad034bc04ab56db&=&format=webp&quality=lossless)
84+
7685
```java
7786
String gradientText = "<GRADIENT:#FF0000>This is a red to yellow gradient</GRADIENT:#FFFF00>";
78-
String processedGradient = ColorUtils.process(gradientText);
87+
String processedGradient = MatrixColorAPI.process(gradientText);
7988
```
8089

8190
- **Legacy Code Support:**
8291

92+
![Legacy Color Example](https://media.discordapp.net/attachments/1262415791731511347/1291384114905092096/image.png?ex=66ffe6ad&is=66fe952d&hm=b6f9d8dcb41a6f09cd1d2f7609fefda99cc01c14a5b2a351ee9bcb2655e46521&=&format=webp&quality=lossless)
93+
8394
```java
8495
String legacyText = "&aThis is a green text with &lBOLD";
85-
String processedLegacy = ColorUtils.process(legacyText);
96+
String processedLegacy = MatrixColorAPI.process(legacyText);
8697
```
8798

8899
- **Hex Code Support:**
89100

101+
![Hex Color Example](https://media.discordapp.net/attachments/1262415791731511347/1291384163072610335/image.png?ex=66ffe6b9&is=66fe9539&hm=9938cbc8816a4f5465cde4af5853ca43e2b002855e3a3b00601c94b498a5a6da&=&format=webp&quality=lossless)
102+
90103
```java
91104
String hexText = "&#FFD700This is a yellow text with &lBOLD";
92-
String processedLegacy = ColorUtils.process(hexText);
105+
String processedLegacy = MatrixColorAPI.process(hexText);
93106
```
94107

95108
## 🛠️ Available Methods
@@ -109,12 +122,12 @@ Make sure to follow the coding standards and include tests where appropriate.
109122

110123
## 📝 License
111124

112-
This project is licensed under the **Apache 2.0 License**. See the [LICENSE](./LICENSE) file for details.
125+
This project is licensed under the **Apache 2.0 License**. See the [LICENSE](./LICENSE.txt) file for details.
113126

114127
## 📢 Acknowledgments
115128

116129
Thanks to everyone contributing to this project! Your support and feedback help make **MatrixColorAPI** even better.
117130

118131
## 👥 Contact
119132

120-
For any questions or feedback, feel free to open an issue or reach out.
133+
For any questions or feedback, feel free to open an issue or reach out to us on our [discord server.](https://discord.gg/B4QsfUrdUR)

0 commit comments

Comments
 (0)