Docs: Update README with security scrubbing feature

[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 #35

Changes Made

• Updated the readme to include information about the scrubber feature

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 a Security & Privacy section explaining local scrubbing of sensitive data before any requests to LLM providers.
  • Listed examples of scrubbed items (API keys, passwords, personal data, environment variables).
  • Updated Features to highlight Smart Security Scrubbing while retaining Easy to Use.
  • Expanded installation/docs with explicit bullets and a note reinforcing local data handling.

[coderabbitai]

Walkthrough

The README was updated to add a Security & Privacy section describing local scrubbing of sensitive data, introduce a “Smart Security Scrubbing” feature in the Features list, and expand installation/documentation notes to emphasize local handling and examples of sensitive items.

Changes

Cohort / File(s)	Summary
Docs: README updates README.md	Added “Security & Privacy” section describing local scrubbing (API keys, passwords, personal data, env vars). Updated Features to include “Smart Security Scrubbing” while retaining “Easy to Use.” Expanded installation/documentation bullets clarifying that scrubbing occurs locally before sending to LLM providers.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I thump my paws in careful cheer,
We scrub the secrets safely here—
Keys and whispers, hop away,
Before the clouds can see the hay.
README blooms with tidy prose,
Security’s carrot freshly shows. 🥕

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 pull request title clearly and concisely summarizes the primary change, indicating an update to the README to include the security scrubbing feature, which matches the documentation focus of the changeset.
Linked Issues Check	✅ Passed	The changes update the README with a new "Security & Privacy" section, feature list updates, and installation notes that directly fulfill the documentation requirements described in issue #35.
Out of Scope Changes Check	✅ Passed	All modifications are confined to the README and relate exclusively to documenting the scrubbing feature, with no unrelated code or documentation changes introduced.
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

---

_{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 d2726ec and effa39b.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build Go Binary (windows-latest)

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Fix the garbled bullet characters.

Line 36 and Line 37 now show the Unicode replacement glyph (�) instead of the intended emoji/bullet, so the rendered feature list looks broken. Please restore the proper characters (e.g., 🎯 or •) before merging.

🤖 Prompt for AI Agents

In README.md around lines 36 to 37 the bullet/emoji characters are showing the
Unicode replacement glyph (�); replace the garbled characters with valid Unicode
bullets or emojis (for example "🎯" or "•" for line 36 and "🚀" or "•" for line
37) and ensure the file is saved with UTF-8 encoding so the characters render
properly across environments.

[DFanso]

Approved 🎊