docs: readme

[fadeev]

Summary by CodeRabbit

• Documentation
  • Rebranded the documentation with the new title "ZetaChain Standard Contracts 🚀".
  • Added new sections: Contents, Installation, OpenZeppelin Integration, and Using ThirdWeb.
  • Provided detailed, user-friendly guidance on deploying cross-chain-ready tokens and NFTs.
  • Enhanced navigability with organized links to resource guides.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request completely overhauls the content and structure of the readme.md file. The document now features a rebranded title, "ZetaChain Standard Contracts 🚀", and additional sections that improve guide navigation and deployment instructions. New sections include an introduction to the contracts, a contents overview, installation guidelines, as well as integration instructions for OpenZeppelin and deployment details for ThirdWeb.

Changes

File	Change Summary
readme.md	Renamed title to "ZetaChain Standard Contracts 🚀" and added new sections: "Contents 📦", "Installation ⚙️", "OpenZeppelin Integration 🏗️", and "Using ThirdWeb 🌐" with instructions and code snippets for deploying and integrating cross-chain ready NFTs and tokens.

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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.

Documentation and Community

• 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

readme.md (1)

22-41: Valuable OpenZeppelin Integration Guidelines with Minor Markdown Adjustments.
The "OpenZeppelin Integration 🏗️" section provides clear, actionable code snippets to help users integrate cross-chain functionality into existing OpenZeppelin upgradeable contracts.

Note: The markdownlint tool highlights a minor issue in the subheadings:

• Line 27: The heading "### For Universal NFT:" has a trailing colon.
• Line 33: The heading "### For Universal Token:" has a trailing colon.

These should be updated to remove the colons for consistency with markdown style guidelines (MD026). For example:

-### For Universal NFT:
+### For Universal NFT

-### For Universal Token:
+### For Universal Token

Implementing this change will ensure that the document adheres to best practices without impacting the clarity of the instructions.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

27-27: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

---

33-33: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b99ad6 and 5af8264.

📒 Files selected for processing (1)

• readme.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

readme.md

27-27: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

---

33-33: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: test (contracts/token)
• GitHub Check: test (contracts/nft)
• GitHub Check: slither (contracts/token, token.sarif)
• GitHub Check: slither (contracts/nft, nft.sarif)

🔇 Additional comments (5)

readme.md (5)

1-6: Clear Rebranding and Introduction Update.
The title change to "ZetaChain Standard Contracts 🚀" and the introductory text effectively communicate the new focus on cross-chain capabilities for ERC-721 (NFT) and ERC-20 (Token) deployments. The updated language is engaging and sets the right tone for the rest of the document.

---

7-13: Enhanced Navigation via Contents Section.
The newly added "Contents 📦" section is a great addition. It provides quick links to essential documentation for Universal NFT and Token, thereby improving overall navigability for the reader.

---

14-21: Well-Structured Installation Instructions.
The "Installation ⚙️" section clearly presents the npm and yarn commands within a neatly formatted bash code block. This enhances user experience by offering straightforward, copy-paste instructions.

---

42-57: Comprehensive ThirdWeb Deployment Section.
The "Using ThirdWeb 🌐" section provides clear guidance on deploying Universal NFTs and Tokens via ThirdWeb, complete with relevant links. This addition expands the document's utility for users exploring alternative deployment platforms.

---

58-61: Effective Documentation References.
The concluding section that directs readers to further NFT and Token documentation is a strong finishing touch, ensuring users have access to more detailed technical resources as needed.