Skip to content

Conversation

@bittcrafter
Copy link
Collaborator

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.

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.
@bittcrafter bittcrafter merged commit f05d429 into rmqtt:master Aug 27, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant