SongodaCore/README.md
2021-07-08 15:37:37 +02:00

59 lines
1.8 KiB
Markdown

<!--suppress HtmlDeprecatedAttribute -->
<div align="center">
# SongodaCore
**An elaborate multi functional general Spigot plugin compatibility core and general use API.**
<!-- Shields -->
[![Discord](https://img.shields.io/discord/293212540723396608?color=7289DA&label=Discord&logo=discord&logoColor=7289DA)](https://discord.gg/songoda)
[![Patreon](https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white)](https://www.patreon.com/join/songoda)
<br>
[![Build](https://github.com/songoda/SongodaCore/actions/workflows/maven.yml/badge.svg)](https://github.com/songoda/SongodaCore/actions/workflows/maven.yml)
[![Latest version](https://img.shields.io/nexus/public/com.songoda/SongodaCore?label=Latest%20version&server=https%3A%2F%2Frepo.songoda.com%2F)](https://repo.songoda.com/#browse/browse:public:com%2Fsongoda%2FSongodaCore)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=songoda_SongodaCore&metric=alert_status)](https://sonarcloud.io/dashboard?id=songoda_SongodaCore)
[![GitHub last commit](https://img.shields.io/github/last-commit/songoda/SongodaCore?label=Last+commit)](https://github.com/songoda/SongodaCore/commits)
</div>
<!-- TODO:
## Documentation
JavaDocs are hosted at ???.
-->
## Maven
**Repository**
```xml
<repository>
<id>songoda-public</id>
<url>https://repo.songoda.com/repository/public/</url>
</repository>
```
**Artifact**
```xml
<dependency>
<groupId>com.songoda</groupId>
<artifactId>SongodaCore</artifactId>
<version>VERSION</version>
</dependency>
```
## Gradle
**Repository**
```groovy
repositories {
maven {
url 'https://repo.songoda.com/repository/public/'
}
}
```
**Artifact**
```groovy
dependencies {
compileOnly 'com.songoda:SongodaCore:VERSION'
}
```