From da273402b56617a249c44214b7f044eec639380d Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Sat, 27 Jul 2024 00:16:44 +0530 Subject: [PATCH] updated links --- Makefile | 4 +- README.md | 130 +++++++++++++++++++++--------------------------------- pom.xml | 2 +- 3 files changed, 53 insertions(+), 83 deletions(-) diff --git a/Makefile b/Makefile index 6ec1612..7c5f2df 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,10 @@ build: mvn -B clean install -ut: +unit-tests: mvn clean test -Punit-tests -it: +integration-tests: mvn clean verify -Pintegration-tests doxygen: diff --git a/README.md b/README.md index 157647b..c733cce 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,46 @@ ### Ollama4j

- ollama4j-icon + ollama4j-icon

A Java library (wrapper/binding) for [Ollama](https://ollama.ai/) server. -Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). +Find more details on the [website](https://ollama4j.github.io/ollama4j/). -![GitHub stars](https://img.shields.io/github/stars/amithkoujalgi/ollama4j) -![GitHub forks](https://img.shields.io/github/forks/amithkoujalgi/ollama4j) -![GitHub watchers](https://img.shields.io/github/watchers/amithkoujalgi/ollama4j) -![Contributors](https://img.shields.io/github/contributors/amithkoujalgi/ollama4j?style=social) -![GitHub License](https://img.shields.io/github/license/amithkoujalgi/ollama4j) +![GitHub stars](https://img.shields.io/github/stars/ollama4j/ollama4j) +![GitHub forks](https://img.shields.io/github/forks/ollama4j/ollama4j) +![GitHub watchers](https://img.shields.io/github/watchers/ollama4j/ollama4j) +![Contributors](https://img.shields.io/github/contributors/ollama4j/ollama4j?style=social) +![GitHub License](https://img.shields.io/github/license/ollama4j/ollama4j) -[//]: # (![GitHub repo size](https://img.shields.io/github/repo-size/amithkoujalgi/ollama4j)) +[//]: # (![GitHub repo size](https://img.shields.io/github/repo-size/ollama4j/ollama4j)) -[//]: # (![GitHub top language](https://img.shields.io/github/languages/top/amithkoujalgi/ollama4j)) +[//]: # (![GitHub top language](https://img.shields.io/github/languages/top/ollama4j/ollama4j)) -![JitPack Downloads This Month Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fjitpack.io%2Fapi%2Fdownloads%2Fio.github.amithkoujalgi%2Follama4j&query=%24.month&label=JitPack%20Downloads%20-%20This%20Month) -![JitPack Downloads This Week Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fjitpack.io%2Fapi%2Fdownloads%2Fio.github.amithkoujalgi%2Follama4j&query=%24.week&label=JitPack%20Downloads%20-%20This%20Week) -![JitPack Downloads Per Month Badge](https://jitpack.io/v/amithkoujalgi/ollama4j/month.svg) -![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/amithkoujalgi/ollama4j/total?label=GitHub%20Package%20Downloads) +[//]: # (![JitPack Downloads This Month Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fjitpack.io%2Fapi%2Fdownloads%2Fio.github.ollama4j%2Follama4j&query=%24.month&label=JitPack%20Downloads%20-%20This%20Month)) +[//]: # (![JitPack Downloads This Week Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fjitpack.io%2Fapi%2Fdownloads%2Fio.github.ollama4j%2Follama4j&query=%24.week&label=JitPack%20Downloads%20-%20This%20Week)) +[//]: # (![JitPack Downloads Per Month Badge](https://jitpack.io/v/ollama4j/ollama4j/month.svg)) +![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/ollama4j/ollama4j/total?label=GitHub%20Package%20Downloads) -![GitHub last commit](https://img.shields.io/github/last-commit/amithkoujalgi/ollama4j?color=green) -[![codecov](https://codecov.io/gh/amithkoujalgi/ollama4j/graph/badge.svg?token=U0TE7BGP8L)](https://codecov.io/gh/amithkoujalgi/ollama4j) -![Build Status](https://github.com/amithkoujalgi/ollama4j/actions/workflows/maven-publish.yml/badge.svg) +![GitHub last commit](https://img.shields.io/github/last-commit/ollama4j/ollama4j?color=green) +[![codecov](https://codecov.io/gh/ollama4j/ollama4j/graph/badge.svg?token=U0TE7BGP8L)](https://codecov.io/gh/ollama4j/ollama4j) +![Build Status](https://github.com/ollama4j/ollama4j/actions/workflows/maven-publish.yml/badge.svg) -[//]: # (![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Famithkoujalgi%2Follama4j&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)) +[//]: # (![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Follama4j%2Follama4j&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)) -[//]: # (![GitHub language count](https://img.shields.io/github/languages/count/amithkoujalgi/ollama4j)) +[//]: # (![GitHub language count](https://img.shields.io/github/languages/count/ollama4j/ollama4j)) ## Table of Contents - [How does it work?](#how-does-it-work) - [Requirements](#requirements) - [Installation](#installation) -- [API Spec](https://amithkoujalgi.github.io/ollama4j/docs/category/apis---model-management) -- [Javadoc](https://amithkoujalgi.github.io/ollama4j/apidocs/) +- [API Spec](https://ollama4j.github.io/ollama4j/docs/category/apis---model-management) +- [Javadoc](https://ollama4j.github.io/ollama4j/apidocs/) - [Development](#development) - [Contributions](#get-involved) - [References](#references) @@ -79,37 +79,21 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). > We have migrated the package repository from Maven Central to GitHub package repository due to technical issues with > publishing. Please update your repository settings to get latest version of Ollama4j. > -> Track the releases [here](https://github.com/amithkoujalgi/ollama4j/releases) and update the dependency version +> Track the releases [here](https://github.com/ollama4j/ollama4j/releases) and update the dependency version > according to your requirements. ### For Maven -#### Using [JitPack](https://jitpack.io/) +#### Using [Maven Central](https://central.sonatype.com/) -[//]: # ([![](https://jitpack.io/v/amithkoujalgi/ollama4j.svg)](https://jitpack.io/#amithkoujalgi/ollama4j)) - -![JitPack](https://img.shields.io/jitpack/version/io.github.amithkoujalgi/ollama4j?style=for-the-badge&label=From%20JitPack) - -1. Add `jitpack.io` repository to your project's `pom.xml` or your `settings.xml`: - -```xml - - - - jitpack.io - https://jitpack.io - - -``` - -2. In your Maven project, add this dependency: +1In your Maven project, add this dependency: ```xml - io.github.amithkoujalgi + io.github.ollama4j ollama4j - 1.0.74 + 1.0.78 ``` @@ -117,9 +101,9 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). [![][ollama4j-releases-shield]][ollama4j-releases-link] -[ollama4j-releases-link]: https://github.com/amithkoujalgi/ollama4j/releases +[ollama4j-releases-link]: https://github.com/ollama4j/ollama4j/releases -[ollama4j-releases-shield]: https://img.shields.io/github/v/release/amithkoujalgi/ollama4j?display_name=release&style=for-the-badge&label=From%20GitHub%20Packages%20 +[ollama4j-releases-shield]: https://img.shields.io/github/v/release/ollama4j/ollama4j?display_name=release&style=for-the-badge&label=From%20GitHub%20Packages%20 1. Add `GitHub Maven Packages` repository to your project's `pom.xml` or your `settings.xml`: @@ -129,7 +113,7 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). github GitHub Apache Maven Packages - https://maven.pkg.github.com/amithkoujalgi/ollama4j + https://maven.pkg.github.com/ollama4j/ollama4j true @@ -163,33 +147,19 @@ Find more details on the [website](https://amithkoujalgi.github.io/ollama4j/). ```xml - io.github.amithkoujalgi + io.github.ollama4j ollama4j - 1.0.74 + 1.0.78 ``` ##### For Gradle -1. Add the `JitPack` repository to your build file - -Add it in your root `build.gradle` at the end of repositories: - -```groovy -dependencyResolutionManagement { - repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) - repositories { - mavenCentral() - maven { url 'https://jitpack.io' } - } -} -``` - -2. Add the dependency +1. Add the dependency ```groovy dependencies { - implementation 'com.github.amithkoujalgi:ollama4j:Tag' + implementation 'com.github.ollama4j:ollama4j:Tag' } ``` @@ -197,20 +167,20 @@ dependencies { [//]: # () -[//]: # (![Maven Central](https://img.shields.io/maven-central/v/io.github.amithkoujalgi/ollama4j)) +[//]: # (![Maven Central](https://img.shields.io/maven-central/v/io.github.ollama4j/ollama4j)) [//]: # () [//]: # ([![][lib-shield]][lib]) -[lib]: https://central.sonatype.com/artifact/io.github.amithkoujalgi/ollama4j +[lib]: https://central.sonatype.com/artifact/io.github.ollama4j/ollama4j [lib-shield]: https://img.shields.io/badge/ollama4j-get_latest_version-blue.svg?style=just-the-message&labelColor=gray #### API Spec > [!TIP] -> Find the full API specifications on the [website](https://amithkoujalgi.github.io/ollama4j/). +> Find the full API specifications on the [website](https://ollama4j.github.io/ollama4j/). #### Development @@ -223,13 +193,13 @@ make build Run unit tests: ```shell -make ut +make unit-tests ``` Run integration tests: ```shell -make it +make integration-tests ``` #### Releases @@ -248,7 +218,7 @@ Newer artifacts are published via GitHub Actions CI workflow when a new release #### Traction -[![Star History Chart](https://api.star-history.com/svg?repos=amithkoujalgi/ollama4j&type=Date)](https://star-history.com/#amithkoujalgi/ollama4j&Date) +[![Star History Chart](https://api.star-history.com/svg?repos=ollama4j/ollama4j&type=Date)](https://star-history.com/#ollama4j/ollama4j&Date) ### Areas of improvement @@ -280,24 +250,24 @@ Newer artifacts are published via GitHub Actions CI workflow when a new release
-![Open Issues](https://img.shields.io/github/issues-raw/amithkoujalgi/ollama4j) -![Closed Issues](https://img.shields.io/github/issues-closed-raw/amithkoujalgi/ollama4j) -![Open PRs](https://img.shields.io/github/issues-pr-raw/amithkoujalgi/ollama4j) -![Closed PRs](https://img.shields.io/github/issues-pr-closed-raw/amithkoujalgi/ollama4j) -![Discussions](https://img.shields.io/github/discussions/amithkoujalgi/ollama4j) +![Open Issues](https://img.shields.io/github/issues-raw/ollama4j/ollama4j) +![Closed Issues](https://img.shields.io/github/issues-closed-raw/ollama4j/ollama4j) +![Open PRs](https://img.shields.io/github/issues-pr-raw/ollama4j/ollama4j) +![Closed PRs](https://img.shields.io/github/issues-pr-closed-raw/ollama4j/ollama4j) +![Discussions](https://img.shields.io/github/discussions/ollama4j/ollama4j)
-[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-raw/amithkoujalgi/ollama4j)) +[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-raw/ollama4j/ollama4j)) -[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-closed-raw/amithkoujalgi/ollama4j)) +[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-closed-raw/ollama4j/ollama4j)) -[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-raw/amithkoujalgi/ollama4j)) +[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-raw/ollama4j/ollama4j)) -[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/amithkoujalgi/ollama4j)) +[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/ollama4j/ollama4j)) -[//]: # (![GitHub Discussions](https://img.shields.io/github/discussions/amithkoujalgi/ollama4j)) +[//]: # (![GitHub Discussions](https://img.shields.io/github/discussions/ollama4j/ollama4j)) Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping @@ -316,8 +286,8 @@ project. **Thanks to the amazing contributors**

- - + +

diff --git a/pom.xml b/pom.xml index 231756a..305405a 100644 --- a/pom.xml +++ b/pom.xml @@ -204,7 +204,7 @@ true mvn-repo-id - false + true