Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MEFRREEX committed Apr 23, 2024
1 parent 2fcd98f commit eefb070
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
<repositories>
<repository>
Expand All @@ -139,12 +151,26 @@ public class Database {
</repository>
</repositories>
```

#### Dependency
Dependency:
```xml
<dependency>
<groupId>com.github.MEFRREEX</groupId>
<artifactId>JOOQConnector</artifactId>
<version>1.0.0</version>
</dependency>
```

### Gradle
Repository:
```groovy
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
```
Dependency:
```groovy
dependencies {
implementation 'com.github.MEFRREEX:JOOQConnector:1.0.0'
}
```

0 comments on commit eefb070

Please sign in to comment.