Restructure README and update contributor docs#119
Merged
Conversation
Lead with quick start and minimal configuration (api_secret, failover, timeout). Move headers, IP detection, and proxy options to Advanced configuration.
Document Makefile targets, GitHub Actions CI, and clarify that GitHub releases and PyPI publish are separate steps.
bartes
changed the title
zuchmanski
approved these changes
Jun 2, 2026
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
2 participants
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
Restructure the README so quick start and minimal configuration come first, with headers, IP detection, and proxy settings under Advanced configuration instead of one long block up front. Update
DEVELOPMENT.rstandRELEASING.rstfor the 7.x workflow (Makefile, CI, separate GitHub release vs PyPI steps).Changes
base_url; cleaner Exceptions list and doc linksmasterbefore tagging,gh release createusage, PyPI publish as a separate step from GitHub releases