Skip to content

Commit 6ece3e1

Browse files
committed
Update README.md
1 parent 2ea21d5 commit 6ece3e1

2 files changed

Lines changed: 41 additions & 5 deletions

File tree

README.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# DataManager
22

33
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![jitpack](https://jitpack.io/v/hteppl/DataManager.svg)](https://jitpack.io/#hteppl/DataManager)
45

56
DataManager is a simple library plugin for Nukkit Minecraft Bedrock core (and forks), that will help you to create and
67
manage your SQL connections with ease.
@@ -26,12 +27,47 @@ Execute 1000 SELECT statements against a DB and map the data returned to a POJO.
2627

2728
## How to install
2829

29-
If any plugin requires a DataManager, you just need to download and install it. Usually it will be enough. Also, you can
30-
configure some default database settings in config.yml file, that plugin will create in `plugins` folder.
30+
If any plugin requires a DataManager, you just need to download and put it in `plugins` folder. Usually it will be
31+
enough. Also, you can configure some default database settings in `config.yml`.
32+
33+
### Maven
34+
35+
```xml
36+
<repositories>
37+
<repository>
38+
<id>jitpack.io</id>
39+
<url>https://jitpack.io</url>
40+
</repository>
41+
</repositories>
42+
```
43+
44+
```xml
45+
<dependency>
46+
<groupId>com.github.hteppl</groupId>
47+
<artifactId>DataManager</artifactId>
48+
<version>2.0.6-SNAPSHOT</version>
49+
</dependency>
50+
```
51+
52+
### Gradle
53+
54+
```groovy
55+
allprojects {
56+
repositories {
57+
maven { url 'https://jitpack.io' }
58+
}
59+
}
60+
```
61+
62+
```groovy
63+
dependencies {
64+
implementation 'com.github.hteppl:DataManager:2.0.6-SNAPSHOT'
65+
}
66+
```
3167

3268
## Configuration
3369

34-
Default plugin config.yml settings.
70+
Default plugin `config.yml` settings.
3571

3672
```yaml
3773
# sqlite path settings for method SQLiteDatabase(String database)
@@ -45,7 +81,7 @@ sqlite:
4581
mysql:
4682
# default mysql connection properties
4783
properties: "useSSL=false&autoReconnect=true&useUnicode=true&serverTimezone=UTC"
48-
# HikariCP connection pool settings (https://github.com/brettwooldridge/HikariCP)
84+
# Hikari connection pool settings (https://github.com/brettwooldridge/HikariCP)
4985
hikari:
5086
auto-commit: true
5187
connection-timeout: 30000

src/main/resources/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sqlite:
99
mysql:
1010
# default mysql connection properties
1111
properties: "useSSL=false&autoReconnect=true&useUnicode=true&serverTimezone=UTC"
12-
# HikariCP connection pool settings (https://github.com/brettwooldridge/HikariCP)
12+
# Hikari connection pool settings (https://github.com/brettwooldridge/HikariCP)
1313
hikari:
1414
auto-commit: true
1515
connection-timeout: 30000

0 commit comments

Comments
 (0)