Docs: align README and NuGet claims with current SDK state (#84)#124
Conversation
📝 WalkthroughWalkthroughThe NuGet package description and README documentation were updated to reflect PeachPayments support, revised gateway and refund descriptions, and GitHub links targeting the ChangesPackage and documentation updates
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
There was a problem hiding this comment.
Pull request overview
This PR aligns public-facing documentation (repo README and NuGet README) plus NuGet package metadata with the current PayBridge SDK implementation, reducing drift between claims and what the SDK actually supports.
Changes:
- Updated repository/NuGet README links from
maintomasterfor LICENSE/CONTRIBUTING references. - Refreshed gateway claims: set supported gateway count to 15, added Peach Payments to the supported gateways table, and added
PaymentGatewayTypeenum entry15. - Softened refund-related wording in the NuGet README to better reflect real-world provider/runtime constraints, and replaced the version-specific
PackageDescriptionwith a stable, evergreen summary.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.nuget.md | Updates branch links, gateway count/table, PaymentGatewayType enum mapping, and refund wording to match current SDK behavior. |
| README.md | Updates branch link and removes stale gateway mention in the feature summary examples. |
| PayBridge.SDK/PayBridge.SDK.csproj | Replaces version-specific PackageDescription with an evergreen package description aligned with current SDK capabilities. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Validation
Notes
Addresses #84
Summary by CodeRabbit