Update README#58
Open
engbergandreas wants to merge 3 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the project’s README to provide clearer installation/usage instructions and adds a markdownlint configuration to standardize Markdown formatting across the repo.
Changes:
- Reworked
README.mdwith installation options (npm/script tag), usage examples (Node + browser), and type-generation instructions. - Added
.markdownlint.jsonto codify Markdown linting rules and relax/selectively configure common rules.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Expanded and reorganized documentation for installation, usage, and type generation. |
| .markdownlint.json | Introduces Markdown linting rules to keep docs formatting consistent. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.