diff --git a/README.md b/README.md index d75a616..3187c24 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,101 @@ # OSQL4J -Lightweight SQL interface for java. \ No newline at end of file +Lightweight SQL interface for java. + +### Usage +
Gradle +

+ +> ##### Groovy DSL + +First, add the repository + +```groovy +repositories { + maven { + url 'https://repo.nevets.tech/repository/maven-public/' + } +} +``` +Then, add the OSQL4J dependency: + +```groovy +dependencies { + implementation "tech.nevets.osql4j:OSQL4J:1.0.1" +} + ``` + +If you want to provide your own jdbc driver dependencies, use the provided no-deps dependency + + ```groovy +dependencies { + implementation "tech.nevets.osql4j:OSQL4J:1.0.1:no-deps" +} + ``` + +> #### Kotlin DSL + +First, add the repository + +```kotlin +repositories { + maven("https://repo.nevets.tech/repository/maven-public/") +} +``` + +Then, add the OSQL4J dependency: + +```kotlin +dependencies { + implementation("tech.nevets.osql4j:OSQL4J:1.0.1") +} +``` + +If you want to provide your own jdbc driver dependencies, use the provided no-deps dependency + +```kotlin +dependencies { + implementation("tech.nevets.osql4j:OSQL4J:1.0.1:no-deps") +} +``` + +

+
+ +
Maven +

+ +First, add the repository + +```xml + + + nevets-tech-repo + https://repo.nevets.tech/repository/maven-public/ + + +``` + +And then add the OSQL4J dependency: + +```xml + + tech.nevets + osql4j + 1.0.1 + +``` + +If you want to provide your own jdbc driver dependencies, use the provided no-deps dependency + +```xml + + tech.nevets + osql4j + 1.0.1 + no-deps + +``` + +

+
\ No newline at end of file