Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
orchestr7 authored Aug 1, 2023
1 parent 9702e8a commit 77b6657
Showing 1 changed file with 32 additions and 19 deletions.
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,40 @@ See the [project website](https://saveourtool.github.io/osv4k/) for documentatio
- Support [_Jackson annotations_](https://github.com/FasterXML/jackson-annotations) for _jvm_ target.

## Dependency

The latest release is available from both _GitHub Packages_ and _Maven Central_.

### <a name="c"></a> If you use Maven Central
<summary>
Gradle
</summary>

<details>
```kotlin
dependencies {
implementation("com.saveourtool.osv4k:osv4k:1.0.0")
}
```
</details>

<summary>
Maven
</summary>

<details>
```xml
<dependency>
<groupId>com.saveourtool.osv4k</groupId>
<artifactId>osv4k-jvm</artifactId>
<version>1.0.0</version>
</dependency>
```
</details>

### If you use Github Packages
For _GitHub Packages_, the repository can be added as follows.

<details>
<summary>For `build.gradle.kts`:</summary>
<summary>1) Update `build.gradle.kts`:</summary>

```kotlin
repositories {
Expand All @@ -42,11 +70,10 @@ repositories {
}
}
```

</details>

<details>
<summary>For `settings.gradle.kts`:</summary>
<summary>2) Update `settings.gradle.kts`:</summary>

```kotlin
dependencyResolutionManagement {
Expand All @@ -70,21 +97,7 @@ dependencyResolutionManagement {

</details>

Then add the dependency as usual:
- Gradle
```kotlin
dependencies {
implementation("com.saveourtool.osv4k:osv4k:1.0.0")
}
```
- Maven
```xml
<dependency>
<groupId>com.saveourtool.osv4k</groupId>
<artifactId>osv4k-jvm</artifactId>
<version>1.0.0</version>
</dependency>
```
3) Then add the dependency as [usual](#c)

## Database and ecosystem specific fields

Expand Down

0 comments on commit 77b6657

Please sign in to comment.