docs: correct the stale claims in the README

[Siddhesh2377]

The README had drifted from the app. Every claim below was checked against the code before changing it. Net 357 lines deleted, 194 added.

What was wrong

• Version badges said SDK 0.16.10 and RN 0.76.5. The repo pins 0.20.19 and RN 0.83.1.
• RunAnywhere.processImageStream does not exist. The app calls RunAnywhere.vlm.generateStream (src/services/VLMService.ts:51). That verb survives only in stale SDK docs.
• "Three RunAnywhere packages" is six: core, proto-ts, llamacpp, onnx, mlx, qhexrt. All six resolve on npm at 0.20.19.
• The whole Customization sample was fictional: LlamaCpp.addModel, Onnx.addModel, ModelCategory.speechRecognition. Replaced with the real RunAnywhere.models.register shape plus the archiveUrl and files[] variants the app uses.
• The NDK pin said 27.1.12297006 in four places. android/build.gradle sets 28.0.13004108.
• The permissions list claimed WRITE_EXTERNAL_STORAGE and READ_EXTERNAL_STORAGE. The manifest has INTERNET and RECORD_AUDIO.
• iOS prerequisite said Xcode 14+. The deployment target is 17.5 throughout the pbxproj and Podfile.
• The architecture tree listed 5 of 7 screens and omitted VisionScreen, ToolCallingScreen, VLMService.ts and utils/.

Sections deleted because they describe things that do not exist

• The rac_defaults_generated.h troubleshooting section. That defect was specific to @runanywhere/core@0.20.18 and was fixed by 4dfccf763, which ships in v0.20.19, the version this repo pins. The section told readers to build iOS only and not to use this repo's own pinned version.
• The patch-package instructions. There is no patches/ directory, no patch-package dependency and no postinstall script.
• The podspecPath rationale for automaticPodsInstallation: false. No @runanywhere package at 0.20.19 uses podspecPath. The manual pod install instruction stays, with an accurate reason.
• A broken CONTRIBUTING.md link, a Discord link, an /api docs link, and an Acknowledgments section crediting react-native-reanimated, which is not a dependency.

What was added

The Hermes manual-iterator rule with a real example from ChatScreen.tsx, since Hermes does not support for await...of over NitroModules async iterables. That iOS builds with the new architecture off while Android builds with it on, and the resulting react-native-screens metro shim. yarn typecheck as the verification gate. The actual eight-entry model catalog.

The absolute "no internet required" privacy claim is softened: the weather tool hits wttr.in and the vision screen fetches remote image URLs.

Two things that should be fixed before this repo is usable from a clean clone

yarn.lock resolves every @runanywhere/* at 0.20.18 while package.json pins 0.20.19. The bump commit did not regenerate the lock. yarn install --immutable, the CI default, fails outright, and 0.20.18 is the exact release with the Android rac_defaults_generated.h build break, so anyone installing from the lock as-is gets an unbuildable Android target.

yarn test cannot work. The script runs jest, but jest is not in devDependencies and does not appear in yarn.lock, and there is no jest.config.js. It is left undocumented here rather than documented as a working command.

Other things noticed, not changed

• ios/RunAnywhereStarter/Info.plist sets RCTNewArchEnabled true while the Podfile passes new_arch_enabled => false and strips RCT_NEW_ARCH_ENABLED from every pod target. The Podfile wins; the plist should agree.
• react-native.config.js and src/App.tsx carry the stale podspecPath rationale in comments.
• react-native-live-audio-stream and react-native-sound are declared and imported nowhere.
• ModelService.tsx and chatSampleTools.ts reference runanywhere-sdks/examples/react-native/..., a pre-0.20.17 path.
• android/build.gradle probes /opt/homebrew/bin for node first, which makes the Android build macOS-specific in a way nothing documents.
• There is no LICENSE file, though the README claims MIT. The claim was kept; the file should be added.

Documentation only. No source changes.

[coderabbitai]

Important

Review available on request

• 🔍 Trigger review

Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment @coderabbitai review to review the latest changes. For a full review, comment @coderabbitai full review.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: fa952cc5-4d69-4d1c-8078-faa848273d82

---

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