Skip to content

Commit 38bbcc0

Browse files
authored
Update README.md with even more updated info
1 parent 9419943 commit 38bbcc0

1 file changed

Lines changed: 22 additions & 4 deletions

File tree

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,27 @@ The **Database** plugin provides a seamless way to handle database credentials a
66

77
To install the Database plugin, follow these steps:
88

9-
Download the latest version of the plugin JAR file from the releases section of the repository.
10-
Place the downloaded JAR file into the plugins directory of your Minecraft server.
9+
* Download the latest version of the plugin JAR file from the [releases](https://github.com/OvercastCommunity/Database/releases) section of the repository.
10+
* Place the downloaded Database.jar file into the plugins directory of your Minecraft server.
11+
* Edit the `Database/config.yml` with the proper credentials
12+
13+
## Example of config.yml
14+
```yml
15+
# Database configuration
16+
database:
17+
# JDBC URL
18+
url: "jdbc:mysql://localhost:3306/minecraft"
19+
# MySQL username
20+
username: "user"
21+
# MySQL password
22+
password: "password"
23+
# Maximum number of connections in the connection pool
24+
max-connections: 10
25+
# Timezone of database
26+
timezone: "America/Los_Angeles"
27+
```
1128
12-
## Setup
29+
## API Setup
1330
1431
To utilize the Database API in your own plugin, follow these steps:
1532
@@ -34,6 +51,7 @@ Add the Database plugin as a dependency in your Maven pom.xml
3451
</dependency>
3552
```
3653

54+
## API Example
3755
Below is an example of how to utilize the Database API:
3856
```java
3957
import java.sql.Connection;
@@ -106,5 +124,5 @@ public class YourPlugin extends JavaPlugin {
106124

107125
## License
108126

109-
The **Database** plugin is open source and released under the MIT License. Please review the license file for more details.
127+
The **Database** plugin is open source and released under the MIT License. Please review the [LICENSE](https://github.com/OvercastCommunity/Database/blob/dev/LICENSE) file for more details.
110128

0 commit comments

Comments
 (0)