Overhaul readme #7
Merged
Conversation
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
Signed-off-by: Mike Szczys <[email protected]>
This commit converts README.rst to README.md. No substantive changes have been made. Signed-off-by: Mike Szczys <[email protected]>
- add overview of functionality - add a supported hardware overview - move Golioth Features above Local set up - Separate Stream from State - Add Stream example JSON - Add LightDB State Example JSON - Clarify LightDB State functionality - update OTA instructions for Packages/Cohorts/Deployments - Move pipelines higher in the document - Reverence the pipelines section from the Stream section - Move hardware variants lower in the document - Simplify the hardware variants section - rename opening section - make all headings after the first subheadings - fix mention of LightDB Stream - properly style admonitions for GitHub - add section for additional sensors/components - remove hardware variations sections - add mention of use cases and link to projects site - add section for asking questions Signed-off-by: Mike Szczys <[email protected]>
Images are no longer displayed in the readme and may be removed. Signed-off-by: Mike Szczys <[email protected]>
MarkoPura
approved these changes
Feb 25, 2025
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.
The astute reviewer may have noticed that this repo doesn't have a pipeline example but the README update references one. This example will be added soon, when the repo is pulled up to the next release of Golioth Firmware SDK.
The build errors encountered by this PR will also be resolved when this reference design is pulled up to the most recent SDK release.
Resolves https://github.com/golioth/devrel-issue-tracker/issues/546