Skip to content

Improve README example and update src/example#4

Merged
winton merged 2 commits into
mainfrom
improve-readme-example
Apr 9, 2026
Merged

Improve README example and update src/example#4
winton merged 2 commits into
mainfrom
improve-readme-example

Conversation

@winton

@winton winton commented Apr 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Replaces the abstract time/plusOne example with a realistic profile-fetching scenario (fetchUser, fetchPosts, formatProfile) that makes the zero-await pattern immediately intuitive
  • Adds a full Example section (with an ASCII dependency graph) before the API reference so readers see the pattern in action before diving into individual functions
  • Rewrites the Why typectl? section with a concrete before/after using the same functions, with a closing "No async. No await. No Promise.all." to drive the point home
  • Removes the old Full example section from the bottom of the README
  • Updates src/example files to match the new README and fixes the pick test in src/spec.ts that referenced the removed plusOne function

Test plan

  • All 38 tests pass (npm test)

Made with Cursor

winton added 2 commits April 8, 2026 23:52
Replace the abstract time/plusOne example with a realistic profile-fetching
scenario that clearly demonstrates the zero-await control flow pattern.
Add a full Example section before the API reference with a dependency graph
diagram, and rewrite the Why typectl? section with matching before/after code.

Made-with: Cursor
@winton winton merged commit 46b7687 into main Apr 9, 2026
3 checks passed
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.

1 participant