Skip to content
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

docs: Update xmtp_mls README.md to remove warning tags and add missing information #1686

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

VolodymyrBg
Copy link

This commit improves the xmtp_mls/README.md documentation by:

  1. Enhancing the documentation for the xmtp-id crate with detailed information about:

    • Identity management for XMTP inboxes
    • Wallet address verification for both EOA and Smart Contract Wallets
    • Legacy V2 identity migration support
    • Core types and traits
    • Smart contract detection utilities
  2. Adding specific information about the TLS configuration used by XMTP:

    • Clarified that XMTP uses the default TLS configuration provided by Rustls
    • Specified that this includes the system's root certificate store
    • Mentioned the modern and secure ciphersuites supported (TLS 1.2/1.3 with AEAD ciphers)
  3. Removing warning tags that indicated missing information

These improvements make the documentation more complete and eliminate TODOs that were present in the file.

@VolodymyrBg VolodymyrBg requested a review from a team as a code owner March 3, 2025 17:21
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