Repository navigation
Overhaul README - #145
Merged
Merged
Overhaul README#145
Conversation
- Lead with a runnable example and clear setup steps - Add a supported devices table and a complete getter reference - Document every device type, including the missing water, occupancy and light sensor sections, with imports in all examples - Explain device objects, reload(), relation_id and error behaviour - Expand scenes (button and timed triggers) and the event listener - Add troubleshooting, related projects and contributing sections - Use absolute links so the README also works on PyPI - Drop the outdated motivation section Also list the Python versions that CI tests (3.8 to 3.14) in the package classifiers, which the Python versions badge shows.
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.
A rewrite of the README, modelled on what well-regarded projects do (requests, httpx, python-kasa, lpgera/dirigera): a runnable example first, a supported devices table, the same layout for every device section, and collapsible troubleshooting.
Rendered on this branch
What changed
gw2-<id>.localname), generating a token and connecting, without the huge fake token.reload()andrelation_id.bed_light), the message format and event types, how to stop it, and reconnecting.pyproject.toml: the classifiers now list Python 3.8–3.14, the versions CI tests, so the Python versions badge is correct.How it was checked