Update README with comprehensive JSON5 usage guide and remove placeholder content #9
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 PR completely updates the project README to provide comprehensive documentation for the JSON5 Kotlin library, replacing the outdated placeholder content that incorrectly claimed the project was "non-functional."
Changes Made
JSON5.parse()and stringifying withJSON5.stringify()JSON5.encodeToString()andJSON5.decodeFromString()Before/After Comparison
Before: Generic template with warning about non-functionality and lengthy Gradle tutorials
After: Professional library documentation with clear API examples and feature explanations
The examples are based on the actual working API and test cases from the codebase, ensuring accuracy and usefulness for developers wanting to use this JSON5 library.
Fixes #8.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.