docs: update README with detailed project features, structure

[nickventon]

The README has been updated to provide a comprehensive overview of the project, including features, setup instructions, usage, development guidelines, and contribution steps.

Summary by CodeRabbit

• Documentation
  • Updated README with corrected title capitalization and a comprehensive guide: overview, features, project structure, prerequisites, setup and installation, configuration, usage examples, development workflow and scripts, contributing guidelines, and licensing.
  • Clarifies integrations (e.g., OpenAI, Redis) to help users understand capabilities and requirements.
  • Improves onboarding and self-serve support for new users.
  • No functional or runtime changes.

[coderabbitai]

Walkthrough

Documentation update to README.md: title capitalization and expanded sections detailing usage with OpenAI and Redis, features, structure, setup, configuration, usage, development, scripts, contributing, and license. No code or runtime behavior changes.

Changes

Cohort / File(s)	Summary of Changes
Documentation README.md	Updated title capitalization and extensively expanded content (usage with OpenAI/Redis, features, project structure, setup, configuration, usage, development, scripts, contributing, license). No functional code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I thump my paws on README ground,
New sections bloom where clues are found.
No code to chase, no bugs to fear—
Just carrots of docs, crisp and clear.
I hop through headings, proud and spry,
A tidy burrow, neatly nigh. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 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, which is a documentation update to the README to include detailed project features and structure.
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
• Commit unit tests in branch readme

---

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.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ec8528 and 71a8d36.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

36-36: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

37-37: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

38-38: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

39-39: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

41-41: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

42-42: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

43-43: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

44-44: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

45-45: Hard tabs
Column: 1

(MD010, no-hard-tabs)

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Replace hard tabs with spaces in the fenced code blocks.

markdownlint flags MD010 on these lines. Swap the leading tab characters for spaces so the snippets stay aligned without tripping the lint rule.

🧰 Tools

🪛 markdownlint-cli2 (0.18.1)

36-36: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

37-37: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

38-38: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

39-39: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

41-41: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

42-42: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

43-43: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

44-44: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

45-45: Hard tabs
Column: 1

(MD010, no-hard-tabs)

🤖 Prompt for AI Agents

In README.md around lines 36 to 45, the fenced code blocks currently use leading
tab characters which trigger markdownlint MD010; replace those leading tabs with
spaces (e.g., 4 spaces) inside the fenced blocks so the block contents remain
aligned and linting passes—update both code fences shown (the git clone/cd block
and the npm/yarn install block) to use spaces instead of tabs.