-
Notifications
You must be signed in to change notification settings - Fork 2
Update README.md, Add README.zh-CN.md
#170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Introduces RuntimeProtoParser<T>, RuntimeProtoReader<T>, and RuntimeProtoWriter<T> for runtime message serialization/deserialization. Adds built-in parsers for char, short, ushort, and related 16-bit types. Updates README with detailed usage and API documentation. Registers new public API entries for these features.
Introduced README.zh-CN.md with a full Simplified Chinese translation and updated the English README.md with language switch links and improved section headings using emojis for clarity and visual appeal.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates and expands the documentation for LightProto, adding a Chinese translation and improving the English README with more comprehensive API documentation and usage guidance. The changes also include moving previously unshipped public APIs to the shipped tracking files and adding a new test project to the solution.
Changes:
- Comprehensive rewrite and expansion of README.md with detailed serialization API documentation, migration guidance, and clarified .NET Standard/Unity support
- Addition of README.zh-CN.md providing a complete Chinese translation of the documentation
- PublicAPI tracking files updated to move runtime parser APIs from Unshipped to Shipped status
- Added LightProto.Cs9Tests project to the solution file
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Major documentation improvements including expanded serialization API sections, RuntimeTypeModel examples, improved surrogates documentation, and better migration guidance |
| README.zh-CN.md | New Chinese translation of the README with complete feature documentation and code examples |
| src/LightProto/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt | Cleared unshipped APIs (moved to shipped) |
| src/LightProto/PublicAPI/netstandard2.0/PublicAPI.Shipped.txt | Added 53 runtime parser and serializer APIs to shipped list |
| src/LightProto/PublicAPI/net/PublicAPI.Unshipped.txt | Cleared unshipped APIs (moved to shipped) |
| src/LightProto/PublicAPI/net/PublicAPI.Shipped.txt | Added 53 runtime parser and serializer APIs to shipped list |
| LightProto.slnx | Added LightProto.Cs9Tests project to solution |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #170 +/- ##
=======================================
Coverage 97.88% 97.88%
=======================================
Files 114 114
Lines 2365 2365
Branches 267 267
=======================================
Hits 2315 2315
Misses 30 30
Partials 20 20 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
This pull request primarily updates the documentation in
README.mdto provide a clearer, more comprehensive, and structured explanation of LightProto's features, usage, and differences from protobuf-net. It also adds a new test project to the solution. The most significant changes include a major rewrite and expansion of the serialization API documentation, clarification of .NET Standard and Unity support, and improved guidance on surrogates and runtime type handling.Documentation improvements and API clarification:
StringInternandRuntimeTypeModelusage.General documentation and language improvements:
Project structure:
LightProto.Cs9Teststo the solution fileLightProto.slnx.