Skip to content

Commit 4226b53

Browse files
authored
Update README.md
1 parent d325caa commit 4226b53

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,45 @@ This library simplifies color management while allowing developers to build beau
2020

2121
### Installation
2222

23-
1. **Add the JAR to your project**: (Instructions to add it as a dependency once you release it, or users can manually download it)
24-
2. **Build the project**: Make sure your project is built with a compatible version of Java.
23+
MatrixColorAPI is hosted on [Jitpack](https://jitpack.io), making it easy to integrate with your Maven or Gradle projects. Follow the steps below to add it to your project:
24+
25+
### Using Gradle
26+
1. **Add the Jitpack repository** to your `build.gradle` file (inside `repositories` block):
27+
```gradle
28+
repositories {
29+
maven { url 'https://jitpack.io' }
30+
}
31+
```
32+
33+
2. **Add the dependency** in your `dependencies` block:
34+
```gradle
35+
dependencies {
36+
implementation 'com.github.MatrixCreations:MatrixColorAPI:v1.0.4'
37+
}
38+
```
39+
40+
### Using Maven
41+
1. **Add the Jitpack repository** to your `pom.xml`:
42+
```xml
43+
<repository>
44+
<id>jitpack.io</id>
45+
<url>https://jitpack.io</url>
46+
</repository>
47+
```
48+
49+
2. **Add the dependency** in your `dependencies` block:
50+
```xml
51+
<dependency>
52+
<groupId>com.github.MatrixCreations</groupId>
53+
<artifactId>MatrixColorAPI</artifactId>
54+
<version>v1.0.4</version>
55+
</dependency>
56+
```
57+
58+
### Additional Information
59+
60+
- For the latest version, visit the [Jitpack page](https://jitpack.io/#MatrixCreations/MatrixColorAPI).
61+
- Ensure you're using Java 16 or higher to avoid compatibility issues.
2562

2663
### Example Usages
2764

0 commit comments

Comments
 (0)