Skip to content

Docs: align README and NuGet claims with current SDK state (#84)#124

Merged
teesofttech merged 1 commit into
masterfrom
docs/issue-84-align-readme-and-nuget-claims
Jul 18, 2026
Merged

Docs: align README and NuGet claims with current SDK state (#84)#124
teesofttech merged 1 commit into
masterfrom
docs/issue-84-align-readme-and-nuget-claims

Conversation

@teesofttech

@teesofttech teesofttech commented Jul 18, 2026

Copy link
Copy Markdown
Owner

Summary

  • fix default-branch links from main to master in repository and NuGet readmes
  • remove stale Fincra mention from top-level README feature summary
  • update NuGet README gateway count to 15 and add PeachPayments to supported table and enum map
  • soften over-broad refund claim wording to match provider/runtime reality
  • replace stale version-specific package description text in csproj metadata

Validation

  • grep checks for stale branch links and removed claims

Notes

  • This is a documentation and package-metadata alignment pass to reduce claim drift.
  • Follow-up docs cleanup can still expand quick-start verification and link-check automation.

Addresses #84

Summary by CodeRabbit

  • Documentation
    • Updated package and README descriptions to highlight secure webhook verification, deterministic routing, persistence support, and unified gateway integration.
    • Added PeachPayments to the documented gateway listings and payment gateway reference.
    • Clarified refund API availability and updated the supported gateway count.
    • Corrected repository links for badges, contributing guidance, and the MIT license.

Copilot AI review requested due to automatic review settings July 18, 2026 16:01
@coderabbitai

coderabbitai Bot commented Jul 18, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The NuGet package description and README documentation were updated to reflect PeachPayments support, revised gateway and refund descriptions, and GitHub links targeting the master branch.

Changes

Package and documentation updates

Layer / File(s) Summary
NuGet package description
PayBridge.SDK/PayBridge.SDK.csproj
Replaces the versioned changelog-style package description with a feature-focused integration summary.
Gateway documentation and repository links
README.md, README.nuget.md
Documents PeachPayments, adds enum value 15, revises refund wording, updates gateway counts, and changes GitHub links to the master branch.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • teesofttech/PayBridge#35: Introduces the PeachPayments enum value and gateway implementation reflected in the documentation.
  • teesofttech/PayBridge#54: Adds PeachPayments across the enum, configuration, DI registration, and gateway implementation.

Suggested labels: area: maintenance

Suggested reviewers: copilot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the PR’s main change: updating README and NuGet documentation to reflect the current SDK state.
✨ 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 docs/issue-84-align-readme-and-nuget-claims

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

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 main to master for LICENSE/CONTRIBUTING references.
  • Refreshed gateway claims: set supported gateway count to 15, added Peach Payments to the supported gateways table, and added PaymentGatewayType enum entry 15.
  • Softened refund-related wording in the NuGet README to better reflect real-world provider/runtime constraints, and replaced the version-specific PackageDescription with 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.

@teesofttech
teesofttech merged commit 5748786 into master Jul 18, 2026
6 checks passed
@teesofttech
teesofttech deleted the docs/issue-84-align-readme-and-nuget-claims branch July 18, 2026 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants