Skip to content

Commit 5f5c1a8

Browse files
committed
Update developer api notes in readme.
1 parent 0add77b commit 5f5c1a8

File tree

1 file changed

+21
-26
lines changed

1 file changed

+21
-26
lines changed

README.md

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -42,52 +42,47 @@ $ gradlew build
4242

4343
If you want to hook SkyChanger into your own plugin or simply want to extend functionality, you may use the provided API. If you feel the API is missing anything, or should be changed, please [let us know](https://github.com/dscalzi/SkyChanger/issues).
4444

45-
**Download Latest**:
45+
### GitHub Packages
4646

47-
Bukkit: [![bintray](https://api.bintray.com/packages/dscalzi/maven/SkyChanger-Bukkit/images/download.svg)](https://bintray.com/dscalzi/maven/SkyChanger-Bukkit/_latestVersion) Sponge: [![bintray](https://api.bintray.com/packages/dscalzi/maven/SkyChanger-Sponge/images/download.svg)](https://bintray.com/dscalzi/maven/SkyChanger-Sponge/_latestVersion)
47+
SkyChanger 5.x+ will be hosted on GitHub packages. See https://github.com/dscalzi/SkyChanger/packages
48+
SkyChanger 4.x and earlier were hosted on jcenter, which shutdown.
4849

4950
*Javadocs are not hosted, however they are provided on the maven repository.*
5051

52+
### Gradle
53+
54+
See https://docs.github.com/articles/configuring-gradle-for-use-with-github-package-registry/ to learn more.
55+
56+
```gradle
57+
58+
dependencies {
59+
// For Bukkit
60+
implementation 'com.dscalzi:skychanger-bukkit:VERSION'
61+
// For Sponge
62+
implementation 'com.dscalzi:skychanger-sponge:VERSION'
63+
}
64+
```
65+
5166
### Maven
5267

53-
```XML
54-
<repository>
55-
<id>jcenter</id>
56-
<name>jcenter-bintray</name>
57-
<url>https://jcenter.bintray.com</url>
58-
</repository>
68+
See https://docs.github.com/articles/configuring-apache-maven-for-use-with-github-package-registry/ to learn more.
5969

70+
```XML
6071
<!-- For Bukkit -->
6172
<dependency>
6273
<groupId>com.dscalzi</groupId>
63-
<artifactId>SkyChanger-Bukkit</artifactId>
74+
<artifactId>skychanger-bukkit</artifactId>
6475
<version>VERSION</version>
6576
</dependency>
6677

6778
<!-- For Sponge -->
6879
<dependency>
6980
<groupId>com.dscalzi</groupId>
70-
<artifactId>SkyChanger-Sponge</artifactId>
81+
<artifactId>skychanger-sponge</artifactId>
7182
<version>VERSION</version>
7283
</dependency>
7384
```
7485

75-
### Gradle
76-
77-
```gradle
78-
79-
repositories {
80-
jcenter()
81-
}
82-
83-
dependencies {
84-
// For Bukkit
85-
implementation 'com.dscalzi:SkyChanger-Bukkit:VERSION'
86-
// For Sponge
87-
implementation 'com.dscalzi:SkyChanger-Sponge:VERSION'
88-
}
89-
```
90-
9186
### Example Usage
9287

9388
```java

0 commit comments

Comments
 (0)