Skip to content

docs: replace the unreleased notice with install instructions #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lesnik512 merged 1 commit into from
Oct 28, 2026
Merged

docs: replace the unreleased notice with install instructions #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ failed transaction rolls the marker back, so a retry processes the message again
It works with SQLAlchemy's asyncio extension on PostgreSQL. It stores no payload, runs no worker,
and never begins, commits or rolls back a transaction for you.

Work in progress: the package is not released yet.
```bash
pip install sqlalchemy-inbox
```

You also need an async PostgreSQL driver, such as asyncpg.

## The table

Expand Down
Loading