Skip to content

docs: simplify README to Option A structure#68

Merged
jonathunne merged 1 commit into
tetherto:mainfrom
ihsraham:feat/readme-option-a
Apr 15, 2026
Merged

docs: simplify README to Option A structure#68
jonathunne merged 1 commit into
tetherto:mainfrom
ihsraham:feat/readme-option-a

Conversation

@ihsraham
Copy link
Copy Markdown
Contributor

@ihsraham ihsraham commented Mar 19, 2026

Summary

  • Rewrite README to Option A structure (badges, single Quick Start snippet, no embedded code blocks)
  • Replace inline code examples with links to runnable scripts in wdk-examples
  • Expand Documentation table with links to Usage, Configuration, and API Reference docs
  • Remove inline API reference (now on docs.wdk.tether.io)

Related PRs

@ihsraham ihsraham force-pushed the feat/readme-option-a branch from c0bf0bb to 37cc847 Compare March 27, 2026 14:15
@ihsraham ihsraham marked this pull request as ready for review April 8, 2026 12:32
@jonathunne jonathunne changed the base branch from develop to main April 9, 2026 13:17
@jonathunne jonathunne merged commit dd04e2f into tetherto:main Apr 15, 2026
1 check passed
@jonathunne jonathunne mentioned this pull request May 6, 2026
3 tasks
jonathunne added a commit to sontuphan/wdk-wallet-evm-erc-4337 that referenced this pull request May 6, 2026
Brings develop up to date with main:
- dependabot security monitoring config (tetherto#76)
- README simplified to Option A structure (tetherto#68)
- public-publish.yml release workflow (replaces develop's older publish.yml)
- build.yml workflow permissions
- wdk-wallet-evm bumped to 1.0.0-beta.11 (tetherto#74)
- version bumped to 1.0.0-beta.6 (released)
- re-use read-only class fix (tetherto#72)
- follow-redirects security patch (tetherto#78)

Resolved conflicts:
- package.json: took main's wdk-wallet-evm 1.0.0-beta.11
- package-lock.json: regenerated via npm install
- src/wallet-account-read-only-evm-erc-4337.js: auto-merged cleanly

Dropped develop's .github/workflows/publish.yml in favor of main's
public-publish.yml (the canonical release workflow used by recent
releases tetherto#73, tetherto#75).

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants