Docs improves #13
Merged
Docs improves #13
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
…arer usage instructions; rename CI workflow to Build in build.yml
…and expanded feature descriptions for better clarity and navigation
…ced description, author info, keywords, and badges
…iles; include types directory in package.json files array
kalwalt
added
documentation
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 updates to project documentation, licensing, and configuration files to improve clarity, compliance, and usability. The most significant changes are the switch to the MIT license, a major enhancement to the
README.mdfor better onboarding and developer experience, and an overhaul of the.npmignorefile to ensure only necessary files are published. Additionally, the build workflow and CI badge references have been updated for consistency.Licensing update:
LICENSE, simplifying legal terms and making the project more permissively licensed.Documentation improvements:
README.mdwith badges, clearer feature descriptions, usage instructions, and troubleshooting section, making it much more accessible for new users and contributors. [1] [2] [3] [4]Package publishing and configuration:
.npmignoreto exclude development, configuration, and environment files, ensuring only relevant files are included in npm releases.Workflow and CI consistency:
CItoBuildin.github/workflows/build.ymlfor better clarity and alignment with project naming conventions.Badges and metadata:
README.mdfor GitHub stars, forks, CI, build, npm version, types, Prettier, license, and code coverage, improving project visibility and transparency.Let me know if you want to discuss any of these changes in more detail!