docs(readme): rewrite with full reference, examples and badges#10
Merged
Conversation
Complete rewrite covering: hardware wiring, architecture diagram, installation, all env vars, CLI/API/Docker usage with examples, full API reference with request/response samples, Home Assistant MQTT integration, development setup, test output, project structure and sensor specifications table. Add CI badge. Co-authored-by: agilicode <agilicode@gmail.com>
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
Complete README rewrite — the previous version was outdated (referenced deleted
sensor-api.py, Python 2 commands, hardcoded IP in cron).Now covers:
Test plan
sensor-api.py