Skip to content

Commit 1eb78ca

Browse files
authored
Create README.md
1 parent effe3ef commit 1eb78ca

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## ✨ Project Essentials: CoreAPI
2+
3+
[![](https://jitpack.io/v/projectessentials/ProjectEssentials-Core.svg)](https://jitpack.io/#projectessentials/ProjectEssentials-Core)
4+
![GitHub](https://img.shields.io/github/license/ProjectEssentials/ProjectEssentials-Core)
5+
6+
> ## CoreAPI for Project Essentials mods.
7+
8+
#### ❗ Compatibility with forge `28.0.X` version.
9+
10+
## 🧐 Install using Gradle:
11+
> ##### If your project uses Gradle as Build Tool, then use the code below to add dependencies:
12+
13+
```groovy
14+
repositories {
15+
maven { url("https://jitpack.io") }
16+
}
17+
18+
dependencies {
19+
compile(
20+
group: "com.github.projectessentials",
21+
name: "ProjectEssentials-Core",
22+
version: "v1.14.4-1.0.0.0"
23+
)
24+
}
25+
```
26+
27+
## 🤔 Install using Maven:
28+
> ##### If your project uses Maven as Build Tool, then use the code below to add dependencies:
29+
30+
```xml
31+
<repositories>
32+
<repository>
33+
<id>jitpack.io</id>
34+
<url>https://jitpack.io</url>
35+
</repository>
36+
</repositories>
37+
38+
<dependency>
39+
<groupId>com.github.projectessentials</groupId>
40+
<artifactId>ProjectEssentials-Core</artifactId>
41+
<version>v1.14.4-1.0.0.0</version>
42+
</dependency>
43+
```
44+
45+
```
46+
Additional information:
47+
- kotlin-std lib version: 1.3.50
48+
- kotlinx serialization version: 0.12.0
49+
- target jvm version: 1.8
50+
```
51+
52+
### After you got the dependencies and the library itself:
53+
54+
# [getting started with read the documentation](./documentation/in-using.md)
55+
56+
> ## Made with 💕 by [MairwunNx](https://mairwunnx.github.io/)

0 commit comments

Comments
 (0)