Write comprehensive README with examples

[meshackyaro]

Description

This issue aims to address the implementation of Write comprehensive README with examples.

The core objective is to: Provide quickstart code snippets showing connection, creation, and funding.

By completing this feature, we will ensure that the TrustFlow protocol maintains its high standards for security, usability, and decentralized logic. This issue requires careful attention to the SDK Wrapper architecture and adherence to the existing project conventions.

When picking up this issue, please ensure you document any new dependencies or architectural decisions made during development.

Component

SDK Wrapper

Difficulty

🟡 Medium

Tasks

• Review existing Typescript abstract classes
• Implement SDK method for: Write comprehensive README with examples
• Ensure Tsup successfully exports to ESM and CJS
• Update typedoc comments for the new feature
• Write Jest tests validating XDR payloads
• Run npm run build to verify standard bundling

Acceptance Criteria

• Feature accurately implements the objective: Provide quickstart code snippets showing connection, creation, and funding.
• Any PR that introduces TypeScript/Rust errors is automatically blocked
• CI pipeline runs in under 3 minutes per PR
• Code is properly reviewed and approved by codeowners

Estimated Time

4-8 hours

[leo1987820]

I'd like to take this issue.

Plan:

• refresh the README quickstart so examples match the current SDK exports
• add connection, create escrow, fund/release-style workflow examples, and environment setup notes
• keep the change documentation-only and run the available build/test checks before opening a PR