Improve README's

[marc-aurele-besner]

User description

Improve README's

• Improve root and each packages readme with usage examples and more context/description
• Add GitHub release tag latest version badge
• Add GitHub actions build status badge
• Add NPM latest version badge
• Add Autonomys banner (will work only when merge with main)

---

PR Type

Documentation

---

Description

• Added a comprehensive Contributor Covenant Code of Conduct to establish community standards and enforcement guidelines.
• Introduced MIT License files across the project and its packages to define usage terms and liability.
• Revamped the main README with detailed usage examples, installation instructions, and contribution guidelines.
• Expanded package-specific READMEs (auto-consensus, auto-drive, auto-id, auto-utils) with comprehensive examples, feature descriptions, and installation instructions.
• Added badges for GitHub release, build status, and NPM version to enhance visibility and status tracking.

---

Changes walkthrough 📝

Relevant files

Documentation

11 files CODE_OF_CONDUCT.md Add Contributor Covenant Code of Conduct                                  CODE_OF_CONDUCT.md Added a comprehensive Contributor Covenant Code of Conduct. Defined community standards and enforcement responsibilities. Included guidelines for reporting and handling incidents. +77/-0    LICENSE Add MIT License file                                                                          LICENSE Added MIT License file for the project. Defined terms of use, warranty, and liability. +18/-0    README.md Revamp main README with examples and badges                            README.md Enhanced README with detailed usage examples. Added badges for GitHub release, build status, and NPM version. Included sections on installation, usage, and contribution. +329/-45 LICENSE Add MIT License for auto-consensus package                              packages/auto-consensus/LICENSE Added MIT License file specific to the auto-consensus package. +18/-0    README.md Expand auto-consensus README with detailed examples            packages/auto-consensus/README.md Expanded README with detailed API usage examples. Added sections on account management, transfers, and staking. Included installation instructions and feature descriptions. +547/-13 LICENSE Add MIT License for auto-drive package                                      packages/auto-drive/LICENSE Added MIT License file specific to the auto-drive package. +18/-0    README.md Create auto-drive README with usage examples                          packages/auto-drive/README.md Created README with usage examples for file and folder DAG creation. Added installation instructions and feature highlights. +116/-1  LICENSE Add MIT License for auto-id package                                            packages/auto-id/LICENSE Added MIT License file specific to the auto-id package. +18/-0    README.md Develop auto-id README with management examples                    packages/auto-id/README.md Developed README with comprehensive Auto ID management examples. Included sections on generating, authenticating, and revoking Auto IDs. Added installation and contribution guidelines. +426/-1  LICENSE Add MIT License for auto-utils package                                      packages/auto-utils/LICENSE Added MIT License file specific to the auto-utils package. +18/-0    README.md Enhance auto-utils README with utility examples                    packages/auto-utils/README.md Enhanced README with detailed utility function examples. Added sections on wallet management, network configuration, and cryptographic operations. Included installation and API activation instructions. +585/-32

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 5 🔵🔵🔵🔵🔵

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Documentation Clarity The documentation for the @autonomys/auto-consensus package is extensive but may overwhelm new users with its depth and technical details. Consider breaking down the information into more digestible parts or providing a quick start section at the beginning. Example Code Error The example code snippets in the @autonomys/auto-drive README might contain errors or be misleading due to the lack of context or explanation about the setup required to run them successfully. Inconsistent Documentation The @autonomys/auto-id README provides a mix of high-level overviews and very detailed code examples. There's a need to balance the introduction of concepts with practical examples to avoid cognitive overload. Missing Context The @autonomys/auto-utils README jumps directly into detailed API usage without sufficient introductory content on what the package does or how it fits into the larger ecosystem.

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[clostao]

Thanks for doing the auto-drive's README

[marc-aurele-besner]

Just realize auto-utils and auto-consensus were generated correctly, but there was some level of halucination for auto-drive and auto-id, will keep on improving