Skip to content

docs: add React Native sherpa-onnx wrapper - #3615

Merged
csukuangfj merged 3 commits into
k2-fsa:masterfrom
deeeed:add-react-native-wrapper
May 18, 2026
Merged

csukuangfj merged 3 commits into
k2-fsa:masterfrom
deeeed:add-react-native-wrapper

Conversation

@abretonc7s

@abretonc7s abretonc7s commented May 15, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Thank you for building sherpa-onnx. I maintain @siteed/sherpa-onnx.rn, a React Native wrapper for using sherpa-onnx in iOS, Android, and Web apps, plus a companion demo app called Sherpa Voice.

This PR adds the wrapper and demo app to the "Projects using sherpa-onnx" section so React Native users can find it.

Links:

Notes

The wrapper is used to validate sherpa-onnx features across React Native apps, including ASR, TTS, VAD, KWS, speaker ID, diarization, language ID, punctuation, audio tagging, and speech enhancement.

Happy to adjust wording or move this elsewhere if maintainers prefer a different location.

Summary by CodeRabbit

  • Documentation
    • README updated with a new "Projects using sherpa-onnx" entry for Sherpa Voice — a React Native demo showcasing ASR, TTS, VAD, KWS, speaker ID/diarization, and language ID; includes links to the NPM package, project repository, and live demo site.

Review Change Stack

@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label May 15, 2026
@coderabbitai

coderabbitai Bot commented May 15, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 44440afb-21ee-458c-8994-9ae2b0c4cad9

📥 Commits

Reviewing files that changed from the base of the PR and between c4eb0bd and 46551da.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The README's "Projects using sherpa-onnx" section now includes a new entry for @siteed/sherpa-onnx.rn (Sherpa Voice) with a short description and links to the NPM package, demo site, and repository.

Changes

README Documentation Update

Layer / File(s) Summary
Project listing addition
README.md
Inserted a new "Projects using sherpa-onnx" entry for @siteed/sherpa-onnx.rn (Sherpa Voice) describing the React Native demo (ASR/TTS/VAD/KWS and speaker ID/diarization/language ID) and adding links to the NPM package, source repo, and demo website.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • csukuangfj

Poem

🐇 A README hop, a new demo sight,
Sherpa Voice arrives, ready to light.
Links like carrots, demos to try,
A rabbit nods and gives a cheer — hi!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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: adding a React Native sherpa-onnx wrapper entry to the README's projects section, which is concise and specific.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md to include the @siteed/sherpa-onnx.rn project and the Sherpa Voice demo app in the list of projects using sherpa-onnx. Feedback was provided to improve the formatting of these additions by using the source repository as the primary header link and streamlining the secondary links for better readability and consistency with existing entries.

Comment thread README.md Outdated
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels May 16, 2026
@abretonc7s

Copy link
Copy Markdown
Contributor Author

Thanks for the review. I pushed 46551da8 to make the listing match the suggested format:

  • primary heading now links to the source repository
  • description is shorter and less repetitive
  • secondary links are limited to the NPM package and live demo

Validation: git diff --check.

@csukuangfj csukuangfj left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution!

@csukuangfj
csukuangfj merged commit 58bb4b8 into k2-fsa:master May 18, 2026
1 check passed
Prithwis-2023 added a commit to Prithwis-2023/sherpa-onnx that referenced this pull request May 18, 2026
docs: add React Native sherpa-onnx wrapper (k2-fsa#3615)
jimmy1984xu pushed a commit to jimmy1984xu/sherpa-onnx that referenced this pull request Jul 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants