docs: Update README for v2.3.1 with accurate documentation

[T-rav]

Summary

• Update version from 2.2.0 → 2.3.1
• Add Docker-first quick start with multi-platform support
• Document bearer authentication feature (v2.3.1)
• Fix environment variables (remove unimplemented rate limiting)
• Add comprehensive make command documentation
• Expand project structure details
• Add Docker multi-platform build documentation
• Update tech stack references (Readability + html2text)

Changes

Version & Badges

• Updated version badge to 2.3.1
• Added Docker Hub badge for multi-platform images

Quick Start

• Restructured with Docker-first approach (recommended)
• Added examples with environment variables
• Documented local development with make commands
• Highlighted multi-platform support (amd64/arm64)

Features

• Noted bearer auth as new in v2.3.1
• Removed "Rate Limited" (not actually implemented)
• Updated tech stack to Readability + html2text

Configuration

• Fixed environment variables table - removed RATE_LIMIT_WINDOW and RATE_LIMIT_MAX_REQUESTS (documented but not implemented in code)
• Kept only implemented variables: SERPER_API_KEY, WEBCAT_API_KEY, PORT, LOG_LEVEL, LOG_DIR

Development

• Added comprehensive make command examples
• Documented pre-commit hooks
• Added CI workflow commands (ci-fast, ci)

New Sections

• Docker Multi-Platform Support - build process, automated releases via GitHub Actions

Limitations

• Updated to reflect actual capabilities
• Added specific note about Serper API limits

Test plan

• All changes are documentation only
• No code changes required
• Pre-commit hooks passed
• README renders correctly on GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation

  • Updated README with Docker quickstart, multi-platform build notes, and deployment examples.
  • Refreshed installation/usage guidance, including new development and production workflows.
  • Clarified search fallback behavior and content extraction approach.
  • Revised architecture diagram and feature list; added tech stack overview.
  • Expanded testing/development instructions and project structure overview.
  • Updated endpoints/configuration notes, limitations, and Python compatibility details.
  • Adjusted branding and footer version references.

• Chores

  • Bumped version to 2.3.1 and updated badges.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation-only update to README.md: version bump to 2.3.1, expanded Docker quickstart and multi-arch notes, revised installation/usage workflows, updated feature list and architecture description (authentication step, Readability + html2text), endpoint/configuration changes, tech stack details, testing/dev updates, project structure illustration, and limitations.

Changes

Cohort / File(s)	Summary
Documentation update (README 2.3.1) README.md	Version bump to 2.3.1; new Docker quickstart, multi-platform buildx notes; updated make/docker-compose workflows; switch content extraction refs to Readability + html2text; add DuckDuckGo fallback in search flow; expand features/auth notes; refresh endpoints/config defaults; add tech stack, testing/dev, project structure, limitations; updated branding/footer.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant U as Client
    participant API as FastAPI Service
    participant Auth as Optional Auth
    participant Search as Search Provider
    participant Ext as Readability + html2text
    participant MD as Markdown Response

    U->>API: Request (query or URL)
    alt Auth enabled (new step)
        API->>Auth: Validate token/session
        Auth-->>API: Auth result
        note over API,Auth: Authentication explicitly documented in 2.3.1
    end

    alt Query requires search
        API->>Search: Serper (if API key set)
        Search-->>API: Results
        opt Fallback path
            API->>Search: DuckDuckGo (no Serper key)
            Search-->>API: Results
            note over API,Search: Fallback to DuckDuckGo when Serper key absent
        end
    end

    alt URL content extraction
        API->>Ext: Fetch + Readability parse
        Ext-->>API: Cleaned text via html2text
        note over API,Ext: Extraction pipeline updated to Readability + html2text
    end

    API->>MD: Assemble Markdown response
    MD-->>U: Markdown output

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• updated readme #18 — Also updates README for authentication and environment variables, including Docker run examples and search key behavior.

Poem

Thump-thump go my paws, release two-three-one,
Dockers set sail, multi-arch in the sun.
Readability nibbles, html2text chews,
DuckDuckGo hops in when keys hit snooze.
Auth guards the garden, endpoints in line—
Carrots of Markdown, crisp and fine. 🥕🐇

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/update-readme-v2.3.1

---

📜 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 5006d25 and 9b9ec02.

📒 Files selected for processing (1)

• README.md (5 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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