Skip to content

Add .md to README and clarify what example does #712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Add .md to README and clarify what example does #712

wants to merge 3 commits into from

Conversation

mjcross
Copy link
Contributor

@mjcross mjcross commented Oct 2, 2025 •
edited
Loading

  1. For pico_w/wifi/mqtt, rename README to README.md to improve how the content renders in an IDE or when browsing the online repository.
  2. Clarify that the example doesn't re-publish the temperature reading if it hasn't changed; so that users can understand why the updates can appear sporadic.
  3. Document how the led status can be checked by subscribing to /led/status

Martin Crossley added 2 commits October 2, 2025 21:18
Add .md to README and clarify what example does
3281a3e 
Renamed README to README.md to improve how it renders in an IDE and when
browsing the online repository. Improved the example description to
clarify why the temperature updates might appear unexpectedly sporadic
to the user; and document how to read the current led status.
Improve comments in mqtt_client example
5a45558
lurch
lurch reviewed Oct 10, 2025
View reviewed changes
@peterharperuk
Copy link
Contributor

Looks good. Just the one typo pointed out by @lurch

@lurch
Copy link
Contributor

lurch commented Oct 10, 2025

FYI #498 is where this example was first added.

@mjcross
Copy link
Contributor Author

mjcross commented Oct 10, 2025

Thanks @peterharperuk and well spotted @lurch - fixed in my a23bca5. One of these days I'll manage to get a PR through without a typo 8-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lurch lurch lurch left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mjcross @peterharperuk @lurch