docs: rewrite README around the real git-like workflow - #22
Merged
Conversation
The old README described the pre-5.9 world (push/pull as gRPC file streaming) and called binary-manager/mysql-embedded 'future placeholders' even though they shipped. Rewritten to be practical and accurate: - Install (binary/container) + how the Dolt binary self-installs. - Quick start: clone/init -> start -> commit -> push -> pull. - Command tables grouped by setup/auth, local workflow, server/versioning. - 'How syncing works' (commit-based push/pull, permissions, TLS) + the transitional gRPC flag note. - Configuration table, architecture (correct contexts), development, security.
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.
Summary
The README described the pre-5.9 world (push/pull as gRPC file streaming) and called
binary-manager/mysql-embedded"future placeholders" even though they shipped. Rewritten to be practical and accurate.Changes
clone/init → start → commit → push → pull.Every documented command matches
deltixhelp output. Docs only — no code.