Repository navigation
Add a Quick start guide and usage section - #18
Merged
Merged
Conversation
The README standard now splits the section into Getting started, the setup a fresh install needs before the first call, and Usage. Every command, tag and env key shown was checked against the package's own provider, config or CLI.
…ters Each value was confirmed by booting the provider under testbench and reading its publish groups and merged config.
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.
Adds the README's
## Quick start guide and usagesection, required by the README standard as of 2026-10-03:### Getting startedthen### Usage. Every command, flag and API shown was checked against this repository's code, and every link resolves.Also corrects the install instructions. PyPI and the Homebrew tap have no
shimkityet (PyPI answers 404), so the README's Install section now gives thegit+httpsroutesdocs/installation.mdalready documented, and both pin the current release,v0.19.0(the docs saidv0.2.2; thev0.19.0wheel asset was confirmed to exist).