Repository navigation
docs: redesign README in the goptics house style, add a logo - #19
Merged
Merged
Conversation
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.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Replaces #18, which merged into
perf/group-commit-bargeinstead ofmain. Same three commits, cherry-picked ontomain. README and logo only: no code changes.What changes
assets/text-logo.svgandtext-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>.CGO_ENABLED=1and a C compiler).RequeueNoAckRows.sqliteq.ymlworkflow; it pointed atgo.yml, which doesn't exist.ackandpriority;__sqliteq_*index names;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.