Skip to content

Commit 26033b7

Browse files
committed
Fix JitPack installation instructions
1 parent 03ad665 commit 26033b7

2 files changed

Lines changed: 50 additions & 16 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 MrCappy
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -69,32 +69,45 @@ nbt.setInt("custom-damage", 150);
6969

7070
## Installation
7171

72+
### Gradle
73+
**Step 1.** Add JitPack repository to your build file
74+
```gradle
75+
dependencyResolutionManagement {
76+
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
77+
repositories {
78+
mavenCentral()
79+
maven { url 'https://jitpack.io' }
80+
}
81+
}
82+
```
83+
84+
**Step 2.** Add the dependency
85+
```gradle
86+
dependencies {
87+
implementation 'com.github.mrcappyy:CoreLib:main-SNAPSHOT'
88+
}
89+
```
90+
7291
### Maven
92+
**Step 1.** Add the JitPack repository
7393
```xml
74-
<repository>
75-
<id>jitpack.io</id>
76-
<url>https://jitpack.io</url>
77-
</repository>
94+
<repositories>
95+
<repository>
96+
<id>jitpack.io</id>
97+
<url>https://jitpack.io</url>
98+
</repository>
99+
</repositories>
100+
```
78101

102+
**Step 2.** Add the dependency
103+
```xml
79104
<dependency>
80105
<groupId>com.github.mrcappyy</groupId>
81106
<artifactId>CoreLib</artifactId>
82107
<version>main-SNAPSHOT</version>
83-
<scope>provided</scope>
84108
</dependency>
85109
```
86110

87-
### Gradle
88-
```kotlin
89-
repositories {
90-
maven { url = uri("https://jitpack.io") }
91-
}
92-
93-
dependencies {
94-
compileOnly("com.github.mrcappyy:CoreLib:main-SNAPSHOT")
95-
}
96-
```
97-
98111
## Quick Start
99112

100113
### Basic Setup

0 commit comments

Comments
 (0)