Mathias/sqltoolkit
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Cleaned up readme

Browse Source
This commit is contained in:
mathias 2021-08-19 23:18:51 +02:00
parent 62a789b7de
commit a1b8e4f3d9
No known key found for this signature in database
GPG Key ID: 8950DF62139C852A
1 changed files with 167 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -15,9 +15,12 @@
<h3 align="center">MySQL Toolkit</h3>
## About The Project
This is a small project for quickly managing a MySQL database in Java. It makes everyday life with a database much easier.
This is a small project for quickly managing a MySQL database in Java. It makes everyday life with a database much
easier.
### Installation
1. Add the jitpack repository to your `pom.xml`
```xml
<repositories>
@ -37,6 +40,7 @@ This is a small project for quickly managing a MySQL database in Java. It makes
```
### Usage Examples
1. Create a connection
- Example of a constructor without optional specifications
```java
@ -47,7 +51,8 @@ This is a small project for quickly managing a MySQL database in Java. It makes
MySQLConnection connection = new MySQLConnection(hostname, username, password, database, LoginParam.AUTO_RECONNECT, LoginParam.NO_SSL).connect();
```
#### Login Parameters
- DEFAULT *(useSSL=false&autoReconnect=true&useUnicode=yes&characterEncoding=UTF-8&useTimezone=true&serverTimezone=UTC)*
- DEFAULT *(
useSSL=false&autoReconnect=true&useUnicode=yes&characterEncoding=UTF-8&useTimezone=true&serverTimezone=UTC)*
- NO_SSL *(useSSL=false)*
- USE_SSL *(useSSL=true)*
- AUTO_RECONNECT *(autoReconnect=true)*
@ -189,8 +194,7 @@ This is a small project for quickly managing a MySQL database in Java. It makes
```java
connection.getTableFactory().register(new ExampleStorage(connection));
```
3. Now you can access your storage medium from everywhere.
Try something like that:
3. Now you can access your storage medium from everywhere. Try something like that:
```java
SQLStorageMedium storage = connection.getTableFactory().getStorage(ExampleStorage.class);
@ -208,15 +212,25 @@ This is a small project for quickly managing a MySQL database in Java. It makes
Distributed under the MIT License. See `LICENSE` for more information.
## End
Currently there are not many features yet, so feel free to write me some suggestions!
Currently, there are not many features yet, so feel free to write me some suggestions!
[contributors-shield]: https://img.shields.io/github/contributors/gnmyt/sqltoolkit.svg?style=for-the-badge
[contributors-url]: https://github.com/gnmyt/sqltoolkit/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gnmyt/sqltoolkit.svg?style=for-the-badge
[forks-url]: https://github.com/gnmyt/sqltoolkit/network/members
[stars-shield]: https://img.shields.io/github/stars/gnmyt/sqltoolkit.svg?style=for-the-badge
[stars-url]: https://github.com/gnmyt/sqltoolkit/stargazers
[issues-shield]: https://img.shields.io/github/issues/gnmyt/sqltoolkit.svg?style=for-the-badge
[issues-url]: https://github.com/gnmyt/sqltoolkit/issues
[license-shield]: https://img.shields.io/github/license/gnmyt/sqltoolkit.svg?style=for-the-badge
[license-url]: https://github.com/gnmyt/sqltoolkit/blob/master/LICENSE.txt