Docs/improve package readmes
Explanation
This PR improves the README files for the following 15 packages by adding clear descriptions of their purposes and usage examples:
base-controller
controller-utils
bridge-status-controller
bridge-controller
assets-controllers
user-operation-controller
transaction-controller
keyring-controller
network-controller
signature-controller
gas-fee-controller
permission-controller
notification-services-controller
multichain-network-controller
preferences-controller
References
addressing issue #5742
Checklist
- [ ] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
- [ ] I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
- [ ] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes
Hi @mcmire , Could you please review the changes and let me know if I’m heading in the right direction? If everything looks good, I’d appreciate it if you could go ahead and merge this. I’ll send a separate PR for the remaining packages shortly. If there’s anything that needs to be changed or improved, please let me know. Thanks!
Thank you @lukasbauer54, I will try to review this when I get a chance.
@mcmire Sure. Let me know if I need to fix anything.