docs: expand root readme with quickstart and missing crates#760
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThe README is reorganized with new foundational sections: header URLs updated to the main branch, a "Getting Started" section introducing the umbrella crate and feature matrix, reorganized crate catalogs by domain (Core, Network, Ledger, Tx Builder, Interop) with additional entries, an "Examples" section with runnable references, and a "Cardano Era Compatibility" section documenting supported eras. ChangesDocumentation Expansion
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
1ce1563 to
e267a2e
Compare
Summary
Refreshes the root
README.mdwith content the workspace had outgrown:master→main).pallas-bech32,pallas-configs,pallas-network2,pallas-validate.pallas-network2is a P2P-focused rewrite ofpallas-network.cargo addsnippets and a pointer toexamples/.hardano,phase2,network2,relaxed,unstable).No changes to per-crate READMEs (those are tracked separately on
docs/tidy-per-crate-readmes).Test plan
main, tables align)./pallas-bech32,/pallas-network2, etc.) resolve.cargo addsnippets are copy-pasteable.pallas/Cargo.toml[features].Summary by CodeRabbit
Release Notes