Improve README#265
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
Updates the README to improve clarity, standardize formatting, and surface peer dependency information for users.
- Refreshed status badges and installation instructions for consistency
- Converted the flat asserts list into a table with peer dependency links
- Standardized descriptions (e.g., acronym casing, added detail) and appended missing reference links
Comments suppressed due to low confidence (3)
README.md:141
- The term “zip code” is U.S.-specific. Please update to “Canadian postal code” to accurately reflect Canada’s addressing format.
Tests if the value is valid Canada zip code.
README.md:20
- [nitpick] The word “some” is repeated. Consider simplifying to “Asserts requiring peer dependencies must have them installed manually.”
Some asserts require manually installing some _peer dependencies_.
README.md:372
- [nitpick] Consider linking the LICENSE file here (e.g.,
[MIT](./LICENSE)) so users can immediately access the full license text.
MIT
risantos
force-pushed
the
support/update-readme
branch
3 times, most recently
from
aee5748 to
68a1fde
Compare
risantos
force-pushed
the
support/update-readme
branch
from
68a1fde to
8a01dca
Compare
franciscocardoso
approved these changes
Jul 1, 2025
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.
Description
READMEfile to better guide users and contributors.