docs: add library mode integration and crate badges to README#267
Merged
bittcrafter merged 1 commit intormqtt:masterfrom Aug 27, 2025
Merged
docs: add library mode integration and crate badges to README#267bittcrafter merged 1 commit intormqtt:masterfrom
bittcrafter merged 1 commit intormqtt:masterfrom
Conversation
Documentation Enhancements: 1. **Added Crate Badges**: - Added crates.io version badge for visibility - Added docs.rs documentation badge pointing to latest version - Added to both English and Chinese READMEs 2. **Library Mode Documentation**: - Added new "Library Mode Integration" section in both languages - Provides clear instructions for embedding rmqtt as a Rust dependency - Includes example Cargo.toml dependency configuration - Links to detailed library documentation in rmqtt/README.md 3. **Bilingual Support**: - English version: "Library Mode Integration" - Chinese version: "通过库方式集成" (Library Mode Integration) - Consistent structure and information across both languages Benefits: - **Better Discoverability**: Developers can easily find the crate on crates.io - **Improved Documentation Access**: Direct link to latest API documentation - **Enhanced Integration Options**: Clear guidance for using rmqtt as a library - **Multilingual Support**: Consistent information for both English and Chinese users The changes make it easier for developers to discover, integrate, and use rmqtt in various deployment scenarios.
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.
Documentation Enhancements:
Added Crate Badges:
Library Mode Documentation:
Bilingual Support:
Benefits:
The changes make it easier for developers to discover, integrate, and use rmqtt in various deployment scenarios.