forked from Mirror/ollama4j
updated README.md
Signed-off-by: koujalgi.amith@gmail.com <koujalgi.amith@gmail.com>
This commit is contained in:
parent
16634e60e4
commit
006b52f3db
64
README.md
64
README.md
@ -38,7 +38,8 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
|
|||||||
- [How does it work?](#how-does-it-work)
|
- [How does it work?](#how-does-it-work)
|
||||||
- [Requirements](#requirements)
|
- [Requirements](#requirements)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [API Spec](#api-spec)
|
- [API Spec](https://amithkoujalgi.github.io/ollama4j/docs/category/apis---model-management)
|
||||||
|
- [Javadoc Spec](https://amithkoujalgi.github.io/ollama4j/apidocs/)
|
||||||
- [Demo APIs](#try-out-the-apis-with-ollama-server)
|
- [Demo APIs](#try-out-the-apis-with-ollama-server)
|
||||||
- [Development](#development)
|
- [Development](#development)
|
||||||
- [Contributions](#get-involved)
|
- [Contributions](#get-involved)
|
||||||
@ -74,25 +75,66 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/).
|
|||||||
|
|
||||||
#### Installation
|
#### Installation
|
||||||
|
|
||||||
In your Maven project, add this dependency:
|
For latest release version, check [here](https://github.com/amithkoujalgi/ollama4j/releases).
|
||||||
|
|
||||||
|
##### For Maven
|
||||||
|
|
||||||
|
1. In your Maven project, add this dependency:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>io.github.amithkoujalgi</groupId>
|
<groupId>io.github.amithkoujalgi</groupId>
|
||||||
<artifactId>ollama4j</artifactId>
|
<artifactId>ollama4j</artifactId>
|
||||||
<version>1.0.70</version>
|
<version>v1.0.74</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
or
|
2. Add repository to your project's pom.xml:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>github</id>
|
||||||
|
<name>GitHub Apache Maven Packages</name>
|
||||||
|
<url>https://maven.pkg.github.com/amithkoujalgi/ollama4j</url>
|
||||||
|
<releases>
|
||||||
|
<enabled>true</enabled>
|
||||||
|
</releases>
|
||||||
|
<snapshots>
|
||||||
|
<enabled>true</enabled>
|
||||||
|
</snapshots>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Add GitHub server to settings.xml. (Usually available at ~/.m2/settings.xml)
|
||||||
|
|
||||||
|
```xml
|
||||||
|
|
||||||
|
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
|
||||||
|
http://maven.apache.org/xsd/settings-1.0.0.xsd">
|
||||||
|
<servers>
|
||||||
|
<server>
|
||||||
|
<id>github</id>
|
||||||
|
<username>USERNAME</username>
|
||||||
|
<password>TOKEN</password>
|
||||||
|
</server>
|
||||||
|
</servers>
|
||||||
|
</settings>
|
||||||
|
```
|
||||||
|
|
||||||
|
##### For Gradle
|
||||||
|
|
||||||
In your Gradle project, add the dependency using the Kotlin DSL or the Groovy DSL:
|
In your Gradle project, add the dependency using the Kotlin DSL or the Groovy DSL:
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
dependencies {
|
dependencies {
|
||||||
|
|
||||||
val ollama4jVersion = "1.0.70"
|
val ollama4jVersion = "1.0.74"
|
||||||
|
|
||||||
implementation("io.github.amithkoujalgi:ollama4j:$ollama4jVersion")
|
implementation("io.github.amithkoujalgi:ollama4j:$ollama4jVersion")
|
||||||
}
|
}
|
||||||
@ -100,15 +142,19 @@ dependencies {
|
|||||||
|
|
||||||
```groovy
|
```groovy
|
||||||
dependencies {
|
dependencies {
|
||||||
implementation("io.github.amithkoujalgi:ollama4j:1.0.70")
|
implementation("io.github.amithkoujalgi:ollama4j:1.0.74")
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Latest release:
|
[//]: # (Latest release:)
|
||||||
|
|
||||||

|
[//]: # ()
|
||||||
|
|
||||||
[![][lib-shield]][lib]
|
[//]: # ()
|
||||||
|
|
||||||
|
[//]: # ()
|
||||||
|
|
||||||
|
[//]: # ([![][lib-shield]][lib])
|
||||||
|
|
||||||
[lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j
|
[lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user