Add comprehensive README documentation

[Copilot]

• Analyze the repository structure and codebase
• Identify key features and components
• Revert previous commits to original state
• Reapply changes with proper commit message format: [tag1,tag2]: message1; message2;
• Task completed successfully

Original prompt

---

This section details on the original issue you should resolve

<issue_title>analyze and update readme</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes analyze and update readme #1

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[maifeeulasad]

@copilot care to read my last 20 commit messages and do all your commits in that pattern. If you have already made changes, please do them again for similarity.

pattern: [tag1,tag2,...,tagn]: message1; message2;

[Copilot]

@copilot care to read my last 20 commit messages and do all your commits in that pattern. If you have already made changes, please do them again for similarity.

pattern: `[tag1,tag2,...,tagn]: mess...

Updated commit messages to follow the pattern [tag1,tag2]: message1; message2;. The changes are in commits d72889a and ed3e14b.

[maifeeulasad]

actually the task failed succuessfully, the goal was to see if @copilot can revert commit in web agent mode or not. Turns out it can't

ref:

[Copilot](https://github.com/maifeeulasad/ollama-java/commits?author=Copilot)
Copilot
committed
20 minutes ago
[Update README with comprehensive documentation](https://github.com/maifeeulasad/ollama-java/pull/2/commits/833a9eeb46f93a5e1d97c49793a3c50c7fcf3ed3)
[Copilot](https://github.com/maifeeulasad/ollama-java/commits?author=Copilot)maifeeulasad
Copilot
and
[maifeeulasad](https://github.com/maifeeulasad/ollama-java/commits?author=maifeeulasad)
committed
15 minutes ago
[[revert]: reverted readme to original state; preparing to recommit with proper format;](https://github.com/maifeeulasad/ollama-java/pull/2/commits/d72889a61f8901aa968f85b3585468b4e17eff0c)
[Copilot](https://github.com/maifeeulasad/ollama-java/commits?author=Copilot)maifeeulasad
Copilot
and
[maifeeulasad](https://github.com/maifeeulasad/ollama-java/commits?author=maifeeulasad)
committed
6 minutes ago
[[readme,docs]: added comprehensive documentation; included features, installation, usage examples, api reference, and build instructions;](https://github.com/maifeeulasad/ollama-java/pull/2/commits/ed3e14bc1342c9df0611bae2e4003739cb73b559)
[Copilot](https://github.com/maifeeulasad/ollama-java/commits?author=Copilot)maifeeulasad
Copilot
and
[maifeeulasad](https://github.com/maifeeulasad/ollama-java/commits?author=maifeeulasad)
committed
6 minutes ago

[Copilot]

Pull request overview

This PR adds comprehensive README documentation for the ollama-java library, transforming the single-line placeholder into a complete, professional documentation file. The README effectively describes the library's purpose as a type-safe Java wrapper for the Ollama API.

Key changes:

• Added detailed library description, features, and installation instructions for Maven and Gradle
• Included multiple code examples demonstrating usage patterns for generation, chat, embeddings, model management, and tool/function calling
• Added API reference tables, project structure, contributing guidelines, and roadmap

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The Maven installation instructions are missing authentication configuration, which is required for accessing GitHub Packages. Similar to the Gradle example, users need to configure credentials in their settings.xml or provide them via command line to download packages from GitHub Packages.

[Copilot]

The statement "Zero runtime dependencies" is inaccurate. According to the pom.xml, Gson is a runtime dependency (not marked as provided scope), so the library does have one runtime dependency. Consider rephrasing to "Minimal dependencies" or "Single runtime dependency (Gson)".

Suggested change

	- 📦 **Zero runtime dependencies** - Only uses Gson for JSON serialization and Lombok for cleaner code (compile-time only)
	- 📦 **Single runtime dependency (Gson)** - Uses Gson for JSON serialization and Lombok for cleaner code (compile-time only)