Improve readme #8
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reorganize README to better communicate value proposition: - Add relatable use cases (customer support, document processing, research) - Show complete 4-file working example in Quick Start - Break out all supported patterns into dedicated section - Add integration section (alongside app, standalone worker, Docker) - Simplify backend section with AWS ElastiCache compatibility note - Add data structures section for building custom APIs/CLIs - Document UI component library - Add comprehensive module reference - Add development environment and contributing guidelines
- Update Module Reference to use `import agentexec as ax` pattern - Remove pip install, only show uv add - Remove submodule import examples, show ax.* pattern
The activity functions return Pydantic schemas that serialize automatically. No need to manually construct dicts.
Replace escape codes with Rich Live display and Table for proper terminal re-rendering without scrolling.
- Combine views.py into single file instead of "(continued)" - Split terminal commands into separate blocks with labels - Add filename comment to Dockerfile.worker
Add cancel_pending cleanup to the Docker worker example using atexit to handle graceful container shutdowns. This complements the standalone worker example which uses KeyboardInterrupt handling.
Simplify cleanup code by having cancel_pending handle the commit itself, removing the need for callers to manage the transaction.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.