Repository navigation
Write the full README - #7
Merged
Merged
Conversation
Covers the three-crate layout with a mermaid diagram, explains the three design choices that shaped the codebase (AOF reusing the wire protocol, lazy TTL expiry, the CLI routing through the server's own command parser instead of a second implementation), documents the protocol/command reference, and walks through building, running, and restarting the server against a log file.
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
1 participant
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 the placeholder README with the real thing: CI/Codecov/license badges, a mermaid architecture diagram across the three crates, a section on the three design decisions that actually shaped this codebase (AOF-reuses-the-wire-protocol, lazy TTL expiry, CLI-routes-through-the-server's-own-parser), the full protocol/command reference, and a quickstart that covers building, running the server with
KVFORGE_AOFset, talking to it with the CLI in both modes, and restarting to prove persistence.