openwakeword: update readme to include link to upstream

[Ramblurr]

The readme for openwakeword addon is misleading as it does not actually use the
original dscripka/openWakeWord project. This PR fixes the link.

Summary by CodeRabbit

• Documentation
  • Updated library references in documentation for wake word detection functionality.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[home-assistant]

Hi @Ramblurr

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Stale

[coderabbitai]

📝 Walkthrough

Walkthrough

The README documentation was updated to reference "pyopen-wakeword" instead of "openWakeWord" when discussing wake word detection capabilities. This is a documentation-only change with no functional modifications to the codebase.

Changes

Cohort / File(s)	Summary
Documentation Updates openwakeword/README.md	Updated library references from "openWakeWord" to "pyopen-wakeword" in documentation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks

✅ 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 accurately describes the main change: updating the README to include a link to the upstream project, which aligns with the PR objective of correcting the documentation to properly reference the upstream project.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between b3c0709 and f99ea78.

📒 Files selected for processing (1)

• openwakeword/README.md

🧰 Additional context used

📓 Path-based instructions (1)

*/**(html|markdown|md)

⚙️ CodeRabbit configuration file

*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

• Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
• In step-by-step instructions, front the location phrase in the instructional sentence.
• In step-by-step instructions, front the 'goal' in the instructional sentence.
• In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
• do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

*/**(html|markdown|md): - Use bold to mark UI strings.

• If "" are used to mark UI strings, replace them by bold.

• Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

• Use sentence-style capitalization also in headings.

do not comment on HTML used for icons

Avoid flagging inline HTML for embedding videos in future reviews for this repository.

Files:

• openwakeword/README.md

🔇 Additional comments (1)

openwakeword/README.md (1)

5-5: Clarify the upstream project reference.

The search results indicate pyopen-wakeword is a Rhasspy-maintained package, but Home Assistant's openwakeword add-on may use wyoming-openwakeword or the original openWakeWord project instead. Verify that pyopen-wakeword is the correct upstream reference for this add-on and not a tangentially related project.

---

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