Skip to content

Commit 4e5b34d

Browse files
committed
Add README and jitpack file.
1 parent 57f80cb commit 4e5b34d

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

.jitpack.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
jdk: openjdk11

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# 📝 ConfigValues
2+
3+
[![](https://jitpack.io/v/community.leaf/configvalues.svg)](https://jitpack.io/#community.leaf/configvalues "Get maven artifacts on JitPack")
4+
[![](https://img.shields.io/badge/License-MPL--2.0-blue)](./LICENSE "Project License: MPL-2.0")
5+
[![](https://img.shields.io/badge/Java-11-orange)](#java-version "Java Version: 11")
6+
[![](https://img.shields.io/badge/View-Javadocs-%234D7A97)](https://javadoc.jitpack.io/community/leaf/configvalues/latest/javadoc/ "View Javadocs")
7+
8+
## Maven
9+
10+
```xml
11+
<repositories>
12+
<repository>
13+
<id>jitpack.io</id>
14+
<url>https://jitpack.io</url>
15+
</repository>
16+
</repositories>
17+
```
18+
19+
```xml
20+
<dependency>
21+
<groupId>community.leaf.configvalues</groupId>
22+
<artifactId>config-values-bukkit</artifactId>
23+
<version><!--release--></version>
24+
</dependency>
25+
```
26+
27+
### Versions
28+
29+
Since we use JitPack to distribute this library, the versions available
30+
are the same as the `tags` found on the **releases page** of this repository.
31+
32+
### Shading
33+
34+
If you intend to shade this library, please consider **relocating** the packages
35+
to avoid potential conflicts with other projects. This library also utilizes
36+
nullness annotations, which may be undesirable in a shaded uber-jar. They can
37+
safely be excluded, and you are encouraged to do so.
38+

0 commit comments

Comments
 (0)