Repository navigation
Rewrite README as an integration guide - #138
Merged
Merged
Conversation
The README covered the example apps and a bare-bones SDK import but
left integrators to work out the rest. Restructure it around the flow
someone actually follows when adding the SDK to an app.
- Add Requirements (iOS 14+ for the payment flow, Swift 5.7+) and an
Installation section that leads with SPM and notes CocoaPods is
local-pod only and goes away on 2 December 2026
- Spell out the three-step payment sequence: initialize on the server,
charge in the app, verify on the server before giving value
- Document the builder options (setDisplayAudience, enableLogging) and
give TransactionResult its own section with a case-by-case table
- Add a supported payment methods table per country/currency, and note
that channels the SDK doesn't support yet aren't shown
- Promote Display audience to a top-level section describing how Zap,
Scan to Pay and Bank Transfer / Pesalink differ per audience
- Add Appearance (light/dark mode) and Testing sections
- Expand the example app instructions with the pod install step
peter-paystack
marked this pull request as ready for review
October 16, 2026 08:32
peter-paystack
requested review from
a team,
michael-paystack,
vusi-paystack and
zaheer-paystack
as code owners
October 16, 2026 08:32
|
zaheer-paystack
approved these changes
Oct 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README covered the example apps and a bare-bones SDK import but
left integrators to work out the rest. Restructure it around the flow
someone actually follows when adding the SDK to an app.