Skip to content

docs: rewrite README for production usage - #10

Merged
ahmed-hashi-01 merged 1 commit into
mainfrom
docs/rewrite-readme
Jun 18, 2026
Merged

ahmed-hashi-01 merged 1 commit into
mainfrom
docs/rewrite-readme

Conversation

@ahmed-hashi-01

Copy link
Copy Markdown
Contributor

Summary

Rewrites the README to better explain DeadlineKit from a production backend user’s perspective.

What changed

  • Added a clearer above-the-fold pitch
  • Simplified install section
  • Added quick start example
  • Added timeout, fallback, and expired-budget behavior explanations
  • Documented AbortSignal behavior and limitations
  • Added observability documentation for onOperationEnd
  • Added consoleLogger usage
  • Added error reference
  • Added terse API reference
  • Added project status and roadmap

Checks

  • npm run typecheck
  • npm test -- --run
  • npm run build

@ahmed-hashi-01
ahmed-hashi-01 merged commit c51af3a into main Jun 18, 2026
2 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