Integrate readme docs

[JonoPrest]

Summary by CodeRabbit

• Documentation
  • Enhanced crate documentation with links to full API reference on docs.rs
  • Updated feature list to highlight Parquet format support, real-time SSE streaming, and production-ready capabilities (rate limiting, retries, error handling)
  • Improved Quick Start example demonstrating querying ERC-20 Transfer events with clearer, simplified configuration
  • Added Main Types reference section for quick API overview

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 00f682cd-9c77-43f1-94f3-b8fa70731cf5

📥 Commits

Reviewing files that changed from the base of the PR and between d1e71d7 and 19bfc0e.

📒 Files selected for processing (3)

• README.md
• hypersync-client/src/lib.rs
• hypersync-client/src/types.rs

---

📝 Walkthrough

Walkthrough

The PR updates crate-level documentation by sourcing it from README.md and fixes rustdoc references in type documentation. All changes are documentation-only with no functional logic modifications.

Changes

Cohort / File(s)	Summary
README Documentation README.md	Added docs.rs link, expanded Features section (Arrow → Arrow and Parquet support, Real-time updates via SSE, Production ready), and reworked Quick Start example from ERC-20 Transfer streaming to USDC contract querying with both request-based and streaming flow alternatives. Added Main Types reference section.
Crate-level Documentation hypersync-client/src/lib.rs	Replaced inline documentation block with #![doc = include_str!("../../README.md")] directive to source crate docs from README.md instead of hardcoded module-level comment.
Type Documentation Fix hypersync-client/src/types.rs	Updated rustdoc references in QueryResponseWithRateLimit<T> from Client::get_with_rate_limit to crate::Client::get_with_rate_limit for proper documentation linking.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• docs: update README  #119: Modifies README.md and crate documentation, directly related documentation update effort.

Suggested reviewers

• keenbeen32

Poem

🐰 Docs bloom bright in the garden, neat,
From README's heart, the tale's complete,
Cross-references link with graceful care,
Examples dance through the spring-fresh air! 🌱✨

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch claude/integrate-readme-docs-USGm7

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[JonoPrest]

Just a few touch ups to the docs Jords but also integrates the main readme as the main header on docs.rs