[J-Varela]

What changed and why?

Closes #31.

Document the prerequisites for the four introductory SDK examples in examples/README.md:

• quickstart.py
• compact.py
• joints.py
• locomotion.py

The new table clarifies that all four use the base cyberwave package with no optional extras, require a Cyberwave API key/backend connection, and are not fully offline. It also distinguishes each example's simulation behavior from its physical-hardware requirements.

I established the prerequisites by reading the four example scripts, pyproject.toml, and the Cyberwave client initialization/runtime behavior. In particular, quickstart.py switches to simulation only for the Go2 locomotion portion, locomotion.py explicitly selects simulation, while compact.py and joints.py keep the default live runtime.

No runtime behavior was changed.

How did you test it?

• Ran git diff --check
• Verified all four referenced scripts and their relative links exist
• Reviewed pyproject.toml to confirm none of the four requires an optional extra
• Reviewed the client initialization/runtime code to confirm API-key/backend and simulation/live behavior
• Did not execute any motion commands, use physical hardware, or require a live robot

Tests were not added because this is a documentation-only change with no behavior change.

Contributor checklist

• I added or updated tests for behavior changes, or explained why they are unnecessary.
• I updated relevant documentation or examples.
• I noted any public API, optional dependency, or simulation/live behavior changes.

Recognition

• Please skip the Discord celebration for this PR.

[github-actions]

Thanks for contributing to the Cyberwave Python SDK, @J-Varela!

Maintainer contacts: @KhushiSharma22. When this PR is ready, we request a maintainer review and run an automated advisory review. CI and human review remain the source of truth.

Please describe what changed and how you tested it. See the contribution guide or ask for help on Discord. Drafts are welcome.

Merged human contributions receive a Discord thank-you. To opt out, check the PR template's Discord opt-out box or add <!-- cyberwave:no-celebration --> to the PR description.

[github-actions]

Automated advisory review · Claude

Commit: d6e93c51a1cb65cf10e787a64de5faeba077223a. Human review and CI are still required.

Only a documentation patch was supplied. No code changes are present in this diff, so there are no behavioral defects to report. The table content looks consistent with the described API, though this review covers only the patch excerpt and not the referenced example scripts themselves.

No high-confidence issues found in the supplied excerpts. This is not an approval.

Coverage: 1 of 1 changed files; patch excerpts only. Generated REST code, lockfiles, notebooks, SVGs, missing patches and files beyond the 40-file / 60,000-character budget are excluded. GitHub may truncate individual patches.

[github-actions]

Slack team notifications

• merged: sent

[github-actions]

Thanks @J-Varela — your contribution has been merged!