Skip to content

docs: add badges and review the READMEs - #11

Merged
iamralch merged 1 commit into
mainfrom
readme-badges
Sep 26, 2026
Merged

iamralch merged 1 commit into
mainfrom
readme-badges

Conversation

@iamralch

Copy link
Copy Markdown
Contributor

Badges

  • Each crate README: crates.io, docs.rs, CI, MSRV (from crates.io's rust-version) and license.
  • Root: a version and a docs badge per crate in the table, plus the edition and Nix Flake badges sqlx-query carries.

I fetched every badge URL, and each renders real data: v0.1.0 for core and D1, v0.2.0 for DO, docs: passing for all three, and msrv: 1.94.

Review

  • Root: adds a "Which one?" section on choosing D1 or Durable Object storage. The crate table now lists core, marked as not a dependency of yours.
  • D1: new "Batches" section with execute_batch and fetch_batch examples. They were previously mentioned only as limitations. The limitation bullets now point to it.
  • DO:
    • new "Transactions" section with the callback example, and what it asks of the caller: the callback must be 'static, and it holds the whole object while it runs;
    • new "Batches" section;
    • the install line and compatibility table move to 0.2, which CI published through trusted publishing;
    • fixes a badly wrapped line.
  • Long code lines are wrapped the way rustfmt would.

docs:, so it triggers no release.

Every crate README gets crates.io, docs.rs, CI, MSRV and license badges,
and the root gets a badge per crate in its table plus the edition and Nix
badges sqlx-query carries. The root also says which driver to pick.

D1 and DO each get a section for what they can do rather than only
limitations: batches for both, with `fetch_batch` for sqlc's `:batch*`
shapes, and transactions for DO, with what a callback transaction asks of
its caller. The DO install line and compatibility table move to 0.2.
@iamralch
iamralch merged commit c72b4ae into main Sep 26, 2026
4 checks passed
@iamralch
iamralch deleted the readme-badges branch September 26, 2026 08:49
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