Skip to content

Expand README with features section and API documentation#103

Merged
bernardladenthin merged 2 commits intomasterfrom
claude/review-readme-docs-biT1j
May 7, 2026
Merged

Expand README with features section and API documentation#103
bernardladenthin merged 2 commits intomasterfrom
claude/review-readme-docs-biT1j

Conversation

@bernardladenthin
Copy link
Copy Markdown
Owner

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

  • Added Features section - Highlights key capabilities including text completion, chat completion, embeddings, reranking, infilling, tokenization, grammar conversion, raw JSON endpoints, model metadata access, and platform/acceleration support
  • Reorganized table of contents - Restructured to include the new Features section as the first item, with updated numbering for all subsequent sections
  • Expanded Documentation - Added three new subsections under Documentation:
    • Chat Completion with code examples showing streaming and blocking modes
    • Embeddings & Reranking with usage examples
    • Raw JSON Endpoints describing the available handler methods and server state management
  • Removed outdated content - Removed the "Download" section with the JAR badge and the Gemma 3/4 support note
  • Enhanced Infilling section - Kept existing content but positioned it after the new Chat Completion section

Notable Details

  • Chat Completion examples demonstrate both streaming (generateChat()) and blocking (chatComplete()) patterns
  • Embeddings section shows how to enable embedding mode and retrieve sentence embeddings
  • Raw JSON Endpoints section documents the full set of handler methods and server management APIs
  • All code examples follow the existing documentation style and patterns

https://claude.ai/code/session_01Phsbbq9JdFU24F9PGwG1wf

claude added 2 commits May 6, 2026 07:58
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.
@bernardladenthin bernardladenthin merged commit 504f9e7 into master May 7, 2026
16 checks passed
@bernardladenthin bernardladenthin deleted the claude/review-readme-docs-biT1j branch May 7, 2026 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants