Skip to content

Commit 7bf80b8

Browse files
committed
docs(readme): add at-a-glance usage and benefits summary
1 parent 625d98d commit 7bf80b8

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Framework-agnostic PHP SDK for PayPal **Webhooks** and legacy **Instant Payment
1111

1212
## Table of Contents
1313

14+
- [At a Glance](#at-a-glance)
1415
- [Why This Package](#why-this-package)
1516
- [Features](#features)
1617
- [Requirements](#requirements)
@@ -39,6 +40,24 @@ Framework-agnostic PHP SDK for PayPal **Webhooks** and legacy **Instant Payment
3940
- [Manual Sandbox Smoke Test](#manual-sandbox-smoke-test)
4041
- [Contributing](#contributing)
4142

43+
## At a Glance
44+
45+
Usage:
46+
47+
- Verify PayPal webhook signatures before processing events.
48+
- Parse webhook payloads into typed event models.
49+
- Route events using clear type-based handlers.
50+
- Process webhooks with idempotency protection and structured outcomes.
51+
- Verify legacy Instant Payment Notification (IPN) during migration windows.
52+
53+
Benefits:
54+
55+
- Security-first verification aligned with PayPal’s flow.
56+
- Typed models and typed exceptions for safer handling.
57+
- Retry controls for transient verification failures.
58+
- Minimal dependencies with framework-agnostic design.
59+
- Backward-compatible event API paths for smoother upgrades.
60+
4261
## Why This Package
4362

4463
This SDK is for PHP projects that need reliable PayPal notification verification without framework lock-in.

0 commit comments

Comments
 (0)