Rewrite api 2 #10
Merged
Rewrite api 2 #10
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
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.
This pull request introduces several improvements and updates to the MAX30001 Arduino library, focusing on enhanced documentation, better platform compatibility, improved CI workflows, and the addition of a comprehensive example for users. The changes make the library easier to use, clarify hardware requirements, and ensure robust automated testing and linting.
Documentation and User Experience Improvements:
README.mdto include a detailed overview, quick start guide, platform requirements, hardware setup tables, API reference, and example descriptions. It now clearly states that low-memory boards (e.g., Arduino Uno, Nano, Leonardo) are not supported and recommends suitable platforms.Continuous Integration and Linting Enhancements:*
Example and Testing Improvements:*