updated README.md to include the ollama setup

[vinyas-bharadwaj]

Description

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code refactoring
• Performance improvement
• Other (please describe):

Related Issue

Fixes #47

Changes Made

• Updated readme to include ollama setup

Testing

• Tested with Gemini API
• Tested with Grok API
• Tested on Windows
• Tested on Linux
• Tested on macOS
• Added/updated tests (if applicable)

Checklist

• My code follows the project's code style
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings or errors
• I have tested this in a real Git repository
• I have read the CONTRIBUTING.md guidelines

Screenshots (if applicable)

Additional Notes

---

For Hacktoberfest Participants

• This PR is submitted as part of Hacktoberfest 2025

Thank you for your contribution! 🎉

Summary by CodeRabbit

• Documentation
  • Added Ollama (local) as a supported LLM option in Features and Supported Providers.
  • Documented new environment variables with defaults: OLLAMA_URL (optional) and OLLAMA_MODEL (optional).
  • Added a dedicated "Ollama (Local LLM)" usage section with install, start, pull model, and export examples.
  • Updated installation/configuration examples and default model naming guidance.
  • Minor wording and punctuation adjustments to lists and tables.

[coderabbitai]

Walkthrough

README.md updated to document Ollama (local) as a supported LLM, add OLLAMA_URL and OLLAMA_MODEL environment variables with defaults, and provide step-by-step local Ollama setup and example commands; minor textual/punctuation edits applied.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added Ollama (local) to Features and Supported LLM Providers; documented OLLAMA_URL and OLLAMA_MODEL env vars and defaults; added "Ollama (Local LLM)" usage/setup steps (install, start server, pull model, example env exports); minor text/punctuation updates.

Sequence Diagram(s)

No sequence diagram provided — changes are documentation-only and do not modify runtime control flow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• added ollama support for running local LLM's, Two new environment var… #43 — Adds Ollama/local LLM integration and corresponding env vars; likely implements code-side support referenced by these README updates.

Suggested labels

documentation

Suggested reviewers

• DFanso

Poem

A rabbit taps its README drum,
“Ollama’s here — local models come!”
Env vars set and steps in line,
Pull the model, start the shine.
Hops of joy — the docs refine. 🐇

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly and accurately describes the main change by indicating that the README has been updated to include the Ollama setup instructions without unnecessary verbosity or irrelevant details.
Linked Issues Check	✅ Passed	The pull request fully addresses the documentation objective by adding Ollama setup instructions to the README including feature listing, environment variable configuration, installation steps, and example usage as specified in issue #47.
Out of Scope Changes Check	✅ Passed	All modifications are confined to the README and pertain directly to the insertion of Ollama setup guidance, with no unrelated or extraneous changes present.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3e1d4f2 and d9e1ac1.

📒 Files selected for processing (1)

• README.md (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

51-51: Bare URL used

(MD034, no-bare-urls)

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43b0e8c and 3e1d4f2.

📒 Files selected for processing (1)

• README.md (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

51-51: Bare URL used

(MD034, no-bare-urls)

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Resolve conflicting Ollama default model docs.

Line 52 documents OLLAMA_MODEL defaulting to qwen2:0.5b, but Line 198 claims the default is llama3. Please pick the correct value and update both locations so readers aren’t misconfigured.

🤖 Prompt for AI Agents

In README.md around lines 52 and 196-199, the documented default for
OLLAMA_MODEL is inconsistent (qwen2:0.5b at line 52 vs llama3 at ~198); choose
the correct canonical default value for OLLAMA_MODEL and update both occurrences
to match exactly (including the example export lines and any inline comment),
and search the rest of the README for other mentions of OLLAMA_MODEL to make
them consistent as well.

[DFanso]

Nice 🎊