Update README Usage section

[luis-dfns]

This PR changes the usage section so that clients are instructed to pass trusted values to the validate function, rather than the results of the API call being validated

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 82fbe9a1-db1a-4c94-ac58-71f0659c4276

📥 Commits

Reviewing files that changed from the base of the PR and between 5ac0c8b and 4389b79.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README's TypeScript integration example is refactored to define yieldId, userWalletAddress, and args as caller-controlled variables at the start of the example. These variables are then referenced when constructing the API request body and again during transaction validation, replacing the prior pattern of extracting yieldId and args from the API response.

Changes

TypeScript Integration Example

Layer / File(s)	Summary
Parameterized Yield integration example README.md	Variables for yieldId, userWalletAddress, and args are defined and used in both API request body construction and transaction validation, replacing prior pattern of reading yieldId and args from API response during validation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through the docs with cheer,
Variables now clear as crystal, my dear,
No more guessing what the response will say,
The caller controls the Shield API way! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific changes made to the README.	Use a more specific title that describes the actual change, such as 'Parameterize Yield integration inputs in README example' or 'Update README to use caller-controlled variables for Yield integration'.

✅ Passed checks (4 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.
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

---

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

Warning

⚠️ This pull request might be slop. It has been flagged by CodeRabbit slop detection and should be reviewed carefully.