refreshed documentation

[virajmehta]

Note

Low Risk
Documentation-only updates; main risk is confusing users if examples diverge from the actual API signatures.

Overview
Updates README and crate-level rustdoc examples to match the current API: Task<State> is implemented with &self methods and run(&self, ..., state); tasks are registered on the DurableBuilder; and start_worker is shown as returning a Result.

Clarifies TaskContext::step semantics (function-pointer f, no captured variables; pass data via params) and documents newer capabilities including application state, heartbeat handles/StepState, task cancellation, transactional emit_event_with, and basic queue management helpers.

^{Written by Cursor Bugbot for commit 51ff0e5. This will update automatically on new commits. Configure here.}

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 51ff0e5171

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".