diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..4426e44 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,9 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +authors: + - family-names: "Koujalgi" + given-names: "Amith" +title: "Ollama4j: A Java Library (Wrapper/Binding) for Ollama Server" +version: "1.1.0" +date-released: 2023-12-19 +url: "https://github.com/ollama4j/ollama4j" diff --git a/README.md b/README.md index e3e4920..5472a8b 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,30 @@ -### Ollama4j - -

+

ollama4j-icon -

+
Ollama4j
+
A Java library (wrapper/binding) for Ollama server. -Find more details on the [website](https://ollama4j.github.io/ollama4j/). +_Find more details on the **[website](https://ollama4j.github.io/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 last commit](https://img.shields.io/github/last-commit/ollama4j/ollama4j?color=green) ![GitHub License](https://img.shields.io/github/license/ollama4j/ollama4j) +[![Run Unit and Integration Tests](https://github.com/ollama4j/ollama4j/actions/workflows/run-tests.yml/badge.svg)](https://github.com/ollama4j/ollama4j/actions/workflows/run-tests.yml) +![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/ollama4j_ollama4j?server=https%3A%2F%2Fsonarcloud.io&label=Sonar%20Quality%20Gate) +[![codecov](https://codecov.io/gh/ollama4j/ollama4j/graph/badge.svg?token=U0TE7BGP8L)](https://codecov.io/gh/ollama4j/ollama4j) +
+ [//]: # (![GitHub repo size](https://img.shields.io/github/repo-size/ollama4j/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.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)) @@ -29,16 +33,6 @@ Find more details on the [website](https://ollama4j.github.io/ollama4j/). [//]: # (![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/ollama4j/ollama4j?color=green) -[![codecov](https://codecov.io/gh/ollama4j/ollama4j/graph/badge.svg?token=U0TE7BGP8L)](https://codecov.io/gh/ollama4j/ollama4j) - -[![Run Unit and Integration Tests](https://github.com/ollama4j/ollama4j/actions/workflows/run-tests.yml/badge.svg)](https://github.com/ollama4j/ollama4j/actions/workflows/run-tests.yml) -![Build Status](https://github.com/ollama4j/ollama4j/actions/workflows/maven-publish.yml/badge.svg) -![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/ollama4j_ollama4j?server=https%3A%2F%2Fsonarcloud.io&label=Sonar%20Quality%20Gate) - - - - [//]: # (![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/ollama4j/ollama4j)) @@ -55,7 +49,7 @@ Find more details on the [website](https://ollama4j.github.io/ollama4j/). - [Contributions](#get-involved) - [References](#references) -#### How does it work? +## How does it work? ```mermaid flowchart LR @@ -69,14 +63,14 @@ Find more details on the [website](https://ollama4j.github.io/ollama4j/). end ``` -#### Requirements +## Requirements -![Java](https://img.shields.io/badge/Java-11_+-green.svg?style=for-the-badge&labelColor=gray&label=Java&color=orange) - - - - - +

+ Java + + Ollama + +

## Installation @@ -192,7 +186,12 @@ dependencies { > [!TIP] > Find the full API specifications on the [website](https://ollama4j.github.io/ollama4j/). -### Development +## Examples + +For practical examples and usage patterns of the Ollama4j library, check out +the [ollama4j-examples](https://github.com/ollama4j/ollama4j-examples) repository. + +## Development Make sure you have `pre-commit` installed. @@ -244,14 +243,24 @@ make integration-tests Newer artifacts are published via GitHub Actions CI workflow when a new release is created from `main` branch. -## Examples +## Get Involved -The `ollama4j-examples` repository contains examples for using the Ollama4j library. You can explore -it [here](https://github.com/ollama4j/ollama4j-examples). +
-## ⭐ Give us a Star! +![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) -If you like or are using this project to build your own, please give us a star. It's a free way to show your support. +
+ +Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping +with code - any sort of contribution is much appreciated. + +
+If you like or are use this project, please give us a ⭐. It's a free way to show your support. +
## Who's using Ollama4j? @@ -270,22 +279,16 @@ If you like or are using this project to build your own, please give us a star. | 11 | Research Article | Article: `Large language model based mutations in genetic improvement` - published on National Library of Medicine (National Center for Biotechnology Information) | [Website](https://pmc.ncbi.nlm.nih.gov/articles/PMC11750896/) | | 12 | renaime | A LLaVa powered tool that automatically renames image files having messy file names. | [Website](https://devpost.com/software/renaime) | -## Traction - -[![Star History Chart](https://api.star-history.com/svg?repos=ollama4j/ollama4j&type=Date)](https://star-history.com/#ollama4j/ollama4j&Date) - -## Get Involved - -
- -![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) - -
+## Growth +

+ + Star History Chart + +

[//]: # (![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-raw/ollama4j/ollama4j)) @@ -297,27 +300,6 @@ If you like or are using this project to build your own, please give us a star. [//]: # (![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 -with code - any sort -of contribution is much appreciated. - -## 🏷️ License and Citation - -The code is available under [MIT License](./LICENSE). - -If you find this project helpful in your research, please cite this work at - -``` -@misc{ollama4j2024, - author = {Amith Koujalgi}, - title = {Ollama4j: A Java Library (Wrapper/Binding) for Ollama Server}, - year = {2024}, - month = {January}, - url = {https://github.com/ollama4j/ollama4j} -} -``` - ### References - [Ollama REST APIs](https://github.com/jmorganca/ollama/blob/main/docs/api.md) @@ -331,7 +313,7 @@ project.

- +