chore: add badges and documentation to README, update dependencies

[shuhuiluo]

Added badges for crates.io and docs.rs to the README, as well as detailed sections on features, testing, and contribution guidelines. Upgraded the uniswap-v3-sdk dependency to version 3.0.0 in Cargo.toml for compatibility improvements.

Summary by CodeRabbit

• New Features

  • Updated dependency version for improved functionality.
  • Added a "Features" section in the documentation outlining key aspects of the SDK.
  • Expanded "Contributing" section with testing and linting details.

• Documentation

  • Introduced badges for documentation and versioning.
  • Enhanced README for clarity and comprehensiveness.

[coderabbitai]

Walkthrough

The pull request involves updating the Cargo.toml and README.md files for the Uniswap V4 SDK. The primary change is upgrading the uniswap-v3-sdk dependency from version 2.9.1 to 3.0.0. The README has been enhanced with badges, a new "Features" section, and more detailed contributing guidelines, providing a more comprehensive overview of the SDK's capabilities and development process.

Changes

File	Change Summary
Cargo.toml	Upgraded uniswap-v3-sdk dependency from 2.9.1 to 3.0.0
README.md	- Added documentation and version badges - Introduced "Features" section - Expanded "Contributing" guidelines with testing and linting details - Added no_std library information

Poem

Behold, the SDK's quantum leap! 🚀
Version bumped with scholarly sweep
Badges shine, features unfurl
Rust's precision starts to twirl
Dependency dance, oh so neat! 🧮

[Sheldon-style mic drop]

---

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.

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

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3277390 and fe0290e.

📒 Files selected for processing (2)

• Cargo.toml (1 hunks)
• README.md (1 hunks)

🔇 Additional comments (3)

Cargo.toml (1)

21-21: Bazinga! This major version upgrade requires careful consideration.

The upgrade from uniswap-v3-sdk 2.9.1 to 3.0.0 represents a significant change that, according to the laws of semantic versioning (which, like the laws of physics, should never be broken), indicates breaking changes.

Let's verify the impact:

README.md (2)

4-5: Well done on the documentation improvements! knocks three times

The addition of badges and comprehensive documentation sections shows a commendable attention to detail. The Features section and no_std note provide essential information for potential users, adhering to proper documentation standards.

Also applies to: 12-22

---

10-10: ⚠️ Potential issue

Good Lord! A concerning admission about missing unit tests.

While I appreciate your honesty, as someone who values precision and correctness, I find it deeply troubling that we're advertising a "feature-complete" SDK that lacks unit tests. This is like claiming to understand quantum mechanics without being able to solve Schrödinger's equation!

Let's verify the test coverage: