diff --git a/README.md b/README.md index 0777dde..e8eccbe 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # JOOQConnector -Library for working with database using JOOQ [![License: GNU GPLv3](https://img.shields.io/badge/License-%20%20GNU%20GPLv3%20-yellow)](LICENSE) [![Version](https://img.shields.io/badge/Version-1.0.0-brightgreen)](https://github.com/MEFRREEX/FormConstructor/releases/tag/2.0.1) [![Jitpack](https://jitpack.io/v/MEFRREEX/JOOQConnector.svg)](https://jitpack.io/#MEFRREEX/JOOQConnector) +## 🤔 About +Library for working with database using JOOQ + +Features: +- SQLite3 support +- MySQL support +- Disabled printing logo and tips from JOOQ +- Inclusion of JOOQ, SQLite and MySQL drivers in jar file + ## 🛠 Examples If you are using a standalone api, you can disable the printing of logo and tips when you run the rpogram @@ -127,10 +135,14 @@ public class Database { } ``` -## 🔌 Maven +## 🔌 Installation + +If you are not using the standalone api version place the plugin of the appropriate version (for your software) in the `plugins` folder. + -#### Repository +### Maven +Repository: ```xml @@ -139,8 +151,7 @@ public class Database { ``` - -#### Dependency +Dependency: ```xml com.github.MEFRREEX @@ -148,3 +159,18 @@ public class Database { 1.0.0 ``` + +### Gradle +Repository: +```groovy +repositories { + mavenCentral() + maven { url 'https://jitpack.io' } +} +``` +Dependency: +```groovy +dependencies { + implementation 'com.github.MEFRREEX:JOOQConnector:1.0.0' +} +```