Fix: README public API section is out of sync with actual contract signatures

[yahia008]

Status: Open - unassigned
Labels: documentation
Priority: High

Description:
The README still shows simplified signatures like create_match(stake_amount, token, game_id, platform) and deposit(match_id), which no longer match the code.

Tasks:

• Update README API examples
• Include player and admin/oracle details where needed

---

[BestBisong]

@BestBisong has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

I would love to work on this Issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @BestBisong to this issue.

[drips-wave]

Congratulations, @chriz-cloud! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 2, 2026.

🧑‍💻 @chriz-cloud: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊

[0xparagon]

@0xparagon has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

i would love to work on this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @0xparagon to this issue.