Files
HMCore/README.md
Wieland Schöbl b26a7cf0ac Update README.md
2021-05-11 15:38:00 +02:00

69 lines
2.7 KiB
Markdown

# Core
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
[![Release](https://jitpack.io/v/org.hmcore/Core.svg)](https://jitpack.io/#org.hmcore/Core)
## The Core Mod of HMCore which powers the whole system.
### TODO
## Use HMCore
### Gradle
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'org.hmcore:Core:{version}'
}
```
### Gradle Kotlin DSL
*Note: If you use Kotlin, you should probably use [core-ktx](https://github.com/HMCore/Core-ktx) instead*
```kotlin
repositories {
maven("https://jitpack.io")
}
dependencies {
implementation("org.hmcore:Core:{version}")
}
```
### Maven
```xml
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>org.hmcore</groupId>
<artifactId>Core</artifactId>
<version>{version}</version>
</dependency>
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/wulkanat"><img src="https://avatars.githubusercontent.com/u/19289296?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wieland Schöbl</b></sub></a><br /><a href="https://github.com/HMCore/Core/commits?author=wulkanat" title="Tests">⚠️</a> <a href="https://github.com/HMCore/Core/commits?author=wulkanat" title="Code">💻</a> <a href="https://github.com/HMCore/Core/commits?author=wulkanat" title="Documentation">📖</a><a href="#ideas-wulkanat" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/UnrealValentin"><img src="https://avatars.githubusercontent.com/u/30842467?v=4?s=100" width="100px;" alt=""/><br /><sub><b>UnrealValentin</b></sub></a><br /><a href="https://github.com/HMCore/Core/commits?author=UnrealValentin" title="Documentation">📖</a> <a href="https://github.com/HMCore/Core/commits?author=UnrealValentin" title="Tests">⚠️</a> <a href="https://github.com/HMCore/Core/commits?author=UnrealValentin" title="Code">💻</a> <a href="#ideas-UnrealValentin" title="Ideas, Planning, & Feedback">🤔</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!