🛠️ Code cleanup & added many new features #1
24
README.md
24
README.md
@ -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
|
||||
|
Reference in New Issue
Block a user