Repository navigation
docs(readme): introduce Culvert to new readers - #116
Merged
Merged
Conversation
The README starts with what Culvert is, the comparison table, the docker run command, the client commands and the opt-in table. It is about 1,100 words. Move the whole cryptography section to docs/cryptography.md. Move the working guide to CONTRIBUTING.md. Match the package description to the GitHub description.
.env.example documents the common variables with example values, not every default. The profile table lists the four profiles with walkthroughs. The example template is named beside them.
A test checks that the docs landing links every page under docs/.
The skip-CI and green-PR rows state the rules. PR numbers and the Ubuntu bump are gone.
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.
The README starts with what Culvert is, the comparison table, the docker run command, the client commands and the opt-in table. It is about 1,100 words.
Move the whole cryptography section to docs/cryptography.md. Move the working guide to CONTRIBUTING.md. Match the package description to the GitHub description.