Document project and packages for pub.dev release

[CharlVS]

Updates and standardizes READMEs across the monorepo to improve developer guidance and prepare packages for pub.dev release.

---

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch cursor/document-project-and-packages-for-pub-dev-release-54bf

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Visit the preview URL for this PR (updated for commit 47ff196):

https://komodo-defi-sdk--pr201-cursor-document-proj-rrvn6g7x.web.app

_{(expires Thu, 28 Aug 2025 17:10:19 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 7f9f5ac39928f333b6e8fcefb7138575e24ed347}

[Copilot]

Pull Request Overview

This PR standardizes and updates READMEs across the Komodo DeFi SDK monorepo to improve documentation quality and prepare packages for pub.dev publication. The changes make package purposes clearer, provide better installation instructions, and include practical usage examples.

• Converts boilerplate auto-generated READMEs to comprehensive package-specific documentation
• Standardizes installation instructions and adds consistent licensing information
• Updates the main repository README to better orient developers to the SDK architecture

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/komodo_wallet_cli/README.md	CLI usage documentation with commands and examples
packages/komodo_wallet_build_transformer/README.md	Build transformer setup with pubspec integration and troubleshooting
packages/komodo_ui/README.md	UI widget library highlights and SDK integration
packages/komodo_symbol_converter/README.md	Simplified converter package overview
packages/komodo_defi_types/README.md	Domain types explanation with examples
packages/komodo_defi_sdk/README.md	Comprehensive SDK guide with quick start and advanced usage
packages/komodo_defi_rpc_methods/README.md	RPC methods usage with client.rpc examples
packages/komodo_defi_local_auth/README.md	Authentication package documentation
packages/komodo_defi_framework/README.md	Framework client documentation covering local/remote/WASM
packages/komodo_coins/README.md	Coins metadata package with filtering strategies
packages/komodo_coin_updates/README.md	Runtime coin updates with provider/repository examples
packages/komodo_cex_market_data/README.md	Market data sources and fallback strategies
packages/dragon_logs/README.md	Installation instruction standardization
packages/dragon_charts_flutter/README.md	Updated chart library documentation
README.md	Main repository overview with SDK quick start

Comments suppressed due to low confidence (1)

packages/komodo_ui/README.md:3

• The description uses a non-standard en dash character (‑) instead of a standard hyphen (-). Consider using 'production-ready' for better compatibility.

Reusable Flutter widgets for DeFi apps built on the Komodo DeFi SDK and Framework. Focused, production‑ready components that pair naturally with the SDK’s managers.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}