docs: reposition README around the full shipped feature set - #17
Merged
Conversation
This was referenced Jul 4, 2026
New tagline and top-of-README quickstart reflecting what Pellet Pilot actually does now (coaching, naming, reports, unified CLI), a "Why" section refreshed with Wrap Coach and Cook Report, and an honest vs-app comparison table -- clear about what it deliberately does NOT do (start/stop/set-temp) alongside what it adds that the app never had (ETA, stall detection, coaching, history, reports). Roadmap rewritten: removes items already shipped this round (stage presets, shareable report), and reframes "packaged install" as "publish to PyPI" now that pip install -e . + a console script already exists.
ctopherwilliams
force-pushed
the
feat/readme-repositioning
branch
from
July 5, 2026 01:50
6f8715c to
7f74792
Compare
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
pip install -e .+ a console script exists.pelletCLI + YAML cook presets #14 → feat: shareable Cook Report (self-contained HTML) #15 → feat: Wrap Coach -- rule-based hold/wrap advice (--coach) #16 → this one.Test plan
pellet watch --preset brisket --speak --coachexample in the README actually expands correctly end-to-end