Skip to content

docs: redesign README in the goptics house style, add a logo - #19

Merged
fahimfaisaal merged 3 commits into
mainfrom
docs/readme-house-style
Oct 23, 2026
Merged

fahimfaisaal merged 3 commits into
mainfrom
docs/readme-house-style

Conversation

@fahimfaisaal

@fahimfaisaal fahimfaisaal commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

Replaces #18, which merged into perf/group-commit-barge instead of main. Same three commits, cherry-picked onto main. README and logo only: no code changes.

What changes

  • Logo: assets/text-logo.svg and text-logo-dark.svg, built like redisq's (three stacked queue bars and the wordmark) in SQLite blue. The README picks the light or dark version with <picture>.
  • Layout: follows redisq's — logo, badges, tagline, section links, then:
    • Features, Installation, Quick Start, Usage, Storage;
    • Configuration, Delivery Guarantees, Upgrading from v0.2, How It Works;
    • Development, API Reference, Star History, Contributing, License.
  • Installation: states the requirements: Go 1.24+ and cgo (mattn/go-sqlite3 needs CGO_ENABLED=1 and a C compiler).
  • New sections:
    • an option table;
    • a delivery-guarantees table;
    • an upgrade list from v0.2. It notes that the path is a plain path, not a DSN, that an open name returns one shared handle, and that recovery runs once per file open, which replaces RequeueNoAckRows.
  • CI badge: now links the sqliteq.yml workflow; it pointed at go.yml, which doesn't exist.
  • Corrections:
    • the column list gains ack and priority;
    • the single-file name rules mention the __sqliteq_* index names;
    • the case-insensitive path note is corrected for Windows;
    • "-wal/-shm" files are described as present only while the file is open.
  • Removed:

Checked

Every claim was checked against the code, with probes where reading wasn't enough. Every Go snippet was compiled and run, including the varmq one against varmq main. Links and anchors were checked against GitHub's heading rules.

A text logo in light and dark variants, built like redisq's: three
stacked queue bars and the wordmark, in SQLite blue. The README follows
redisq's layout: logo, badges, tagline and section links, then
features, installation (Go 1.24+ and cgo), quick start, usage, storage,
configuration, delivery guarantees, upgrading from v0.2, how it works,
development, contributing and license.

New sections: a delivery guarantees table; an upgrade list (the path is
a plain path, not a DSN; one shared handle per open name; recovery once
per file open, which replaces RequeueNoAckRows); an option table. The
CI badge now links the sqliteq.yml workflow. The column list gains ack
and priority, and the single-file name rules note the index names.

The measured WAL sizes are left out until the benchmark they come from
is published; the computed sizes stay.
@fahimfaisaal
fahimfaisaal merged commit af7cfb4 into main Oct 23, 2026
1 check passed
@codecov

codecov Bot commented Oct 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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