doc: Clean up README - #496
Merged
Merged
Conversation
kadler
commented
Sep 23, 2026
kadler
commented
Member
- Fix (most) markdown lint warnings. There are still warnings about duplicate headings and using emphasis instead of headings.
- Add badge for Node version support
- Remove horizontal rules
- Remove empty Drivers section.
- Remove Requirements section. This is duplicated with Installation.
- Simplify Installation section. Most users don't need the devel packages due to prebuilt binaries.
- Remove Future Improvements section. This is assumed unless the package states they are stable/maintenance only.
- Remove license text from README since it's already in the LICENSE file. Update LICENSE file to match README and add update copyright for 2026.
- Fix (most) markdown lint warnings. There are still warnings about duplicate headings and using emphasis instead of headings. - Add badge for Node version support - Remove horizontal rules - Remove empty Drivers section. - Remove Requirements section. This is duplicated with Installation. - Simplify Installation section. Most users don't need the devel packages due to prebuilt binaries. - Remove Future Improvements section. This is assumed unless the package states they are stable/maintenance only. - Remove license text from README since it's already in the LICENSE file. Update LICENSE file to match README and add update copyright for 2026.
kadler
force-pushed
the
readme-cleanup
branch
from
September 23, 2026 20:41
55e8d1c to
eadc788
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
2 participants
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.