[CI SKIP] Added API to the readme file

This commit is contained in:
OmerBenGera 2021-01-12 20:23:09 +02:00
parent 6c39d2bbf1
commit 49340ebfb4

View File

@ -12,6 +12,38 @@ You must add yourself all the private jars or purchase access to our private rep
##### Private Jars:
- EpicSpawners by Songoda [[link]](https://songoda.com/marketplace/product/13)
## API
You can hook into the plugin by using the built-in API module.<br>
The API module is safe to be used, its methods will not be renamed or changed, and will not have methods removed
without any further warning.<br>
You can add the API as a dependency using Maven or Gradle:<br>
#### Maven
```
<repository>
<id>bg-repo</id>
<url>https://repo.bg-software.com/repository/api/</url>
</repository>
<dependency>
<groupId>com.bgsoftware</groupId>
<artifactId>WildLoadersAPI</artifactId>
<version>latest</version>
</dependency>
```
#### Gradle
```
repositories {
maven { url 'https://repo.bg-software.com/repository/api/' }
}
dependencies {
compileOnly 'com.bgsoftware:WildLoadersAPI:latest'
}
```
## Updates
This plugin is provided "as is", which means no updates or new features are guaranteed. We will do our best to keep