Chore: update README.md

[mrejdak]

Summary by CodeRabbit

• Documentation
  • Updated API documentation to clarify required parameters for sensor availability functionality.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 99ce6b41-b5d4-4d5f-83e7-56499980a89e

📥 Commits

Reviewing files that changed from the base of the PR and between 8d595a4 and 6bd01bb.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README.md file is updated to reflect a type signature change in the SensorInfo documentation, making the isDeviceSecure property required rather than optional in the isSensorAvailable() function return type.

Changes

Cohort / File(s)	Summary
Documentation Update README.md	Updated SensorInfo type definition: made isDeviceSecure a required property instead of optional (isDeviceSecure?: boolean → isDeviceSecure: boolean).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• fix(Android + iOS): missleading optional #84: Updates the actual TypeScript interface definitions for SensorInfo to make isDeviceSecure required, mirroring the same type signature change documented in this README update.
• chore: update README.md #80: Also modifies the SensorInfo type definition in README.md for the isDeviceSecure field.

Poem

🐰 A property once optional, now required,
Device security firmly assured,
No question marks in the type's declare,
The biometric sensors know we care! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Chore: update README.md' is vague and generic, failing to convey the specific purpose of the change (fixing the SensorInfo type signature).	Revise the title to be more descriptive, such as 'Fix: make isDeviceSecure required in SensorInfo type' or 'Docs: update SensorInfo type signature in README'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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