From 6c4fc954930cc676412ef6a7c5286ff6e764fed6 Mon Sep 17 00:00:00 2001 From: Amith Koujalgi Date: Wed, 8 Nov 2023 14:02:54 +0530 Subject: [PATCH] init --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc7907c..c20a202 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,19 @@ A Java library (wrapper) for [Ollama](https://github.com/jmorganca/ollama/blob/m ![Build Status](https://github.com/amithkoujalgi/ollama4j/actions/workflows/maven-publish.yml/badge.svg) +## Table of Contents + +- [Requirements](#requirements) +- [Installation](#installation) +- [Demo APIs](#try-out-the-apis) +- [Contributions](#get-involved) + #### Requirements - Ollama (Either [natively](https://ollama.ai/download) setup or via [Docker](https://hub.docker.com/r/ollama/ollama)) - Java 8 or above -#### Install +#### Installation In your Maven project, add this dependency available in the [Central Repository](https://s01.oss.sonatype.org/#nexus-search;quick~ollama4j): @@ -181,6 +188,11 @@ GROUP BY customers.name; Find the full `Javadoc` (API specifications) [here](https://amithkoujalgi.github.io/ollama4j/). +#### Areas of improvement + +- Use Java-naming conventions for attributes in the request/response models instead of the snake-case conventions. ( + possibly with Jackson-mapper's `@JsonProperty`) + #### Get Involved Contributions are most welcome! Whether it's reporting a bug, proposing an enhancement, or helping with code - any sort