Skip to content

Commit ddf6fe4

Browse files
committed
Add Installation instructions
1 parent fa36063 commit ddf6fe4

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,52 @@ public class MyPlugin extends JavaPlugin {
120120

121121
---
122122

123+
## Maven / Gradle Installation
124+
125+
To include PrismaticAPI to the project, add the following repository and dependency to your build configuration. Replace `${version}` with the desired version tag.
126+
127+
### Maven
128+
129+
Add the repository and dependency to your `pom.xml`:
130+
131+
```xml
132+
<repositories>
133+
<repository>
134+
<id>croabeast-repo</id>
135+
<url>https://croabeast.github.io/repo/</url>
136+
</repository>
137+
</repositories>
138+
139+
<dependencies>
140+
<dependency>
141+
<groupId>me.croabeast</groupId>
142+
<artifactId>PrismaticAPI</artifactId>
143+
<version>${version}</version>
144+
<scope>compile</scope>
145+
</dependency>
146+
</dependencies>
147+
```
148+
149+
### Gradle
150+
151+
Add the repository and dependency to your `build.gradle`:
152+
153+
```groovy
154+
repositories {
155+
maven {
156+
url "https://croabeast.github.io/repo/"
157+
}
158+
}
159+
160+
dependencies {
161+
implementation "me.croabeast:PrismaticAPI:${version}"
162+
}
163+
```
164+
165+
Replace `${version}` with the appropriate module version.
166+
167+
---
168+
123169
## Conclusion
124170

125171
**PrismaticAPI** consolidates advanced color manipulation and text formatting functions into a single, easy-to-use API. Whether you need to create eye-catching gradients, implement dynamic rainbow effects, or simply clean up formatted text, PrismaticAPI provides the tools to do so effectively. Its support for both legacy and modern RGB formats ensures broad compatibility across different server versions and player clients.

0 commit comments

Comments
 (0)