Expand README with features section and API documentation#103
Merged
bernardladenthin merged 2 commits intomasterfrom May 7, 2026
Merged
Expand README with features section and API documentation#103bernardladenthin merged 2 commits intomasterfrom
bernardladenthin merged 2 commits intomasterfrom
Conversation
The README was missing key features added since the chat-integration and JSON-bridge refactors: chat completion (chatComplete/generateChat), embeddings/reranking helpers, raw JSON endpoint handlers, model metadata, and server management. Adds short overview-level sections for each, drops the broken dist/ download link and the stale Gemma 3/4 banner.
New maintainer fork with breaking changes (groupId/package rename de.kherud → net.ladenthin, AutoCloseable LlamaIterator, canonical-format rerank scores, new LlamaOutput.stopReason field) warrants a major bump. SNAPSHOT marks the in-development line until the first 5.0.0 release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR significantly expands the README documentation to provide a more comprehensive overview of the library's capabilities and usage patterns. The changes reorganize the table of contents, add a dedicated Features section, and include new documentation for chat completion, embeddings/reranking, and raw JSON endpoints.
Key Changes
Notable Details
generateChat()) and blocking (chatComplete()) patternshttps://claude.ai/code/session_01Phsbbq9JdFU24F9PGwG1wf