docs(readme): refresh integration guidance - #45
Merged
Conversation
Rewrite the README around the stable integration contract instead of the aging sample implementation details.\nUpdate the Gradle snippets, fix broken Java examples, and separate recommended usage from legacy compatibility notes so integrators can modernize without changing the SumUp API surface.
Rework the README presentation to match the style used in sibling SumUp SDK repositories with a centered title and repository badges.\nKeep the refreshed Android integration guidance, but make the landing section look more like a maintained product README instead of a raw sample-app note.
Normalize the README prose so regular paragraphs stay on single lines instead of being manually wrapped.\nKeep list structure and code blocks unchanged while matching the preferred repository Markdown style.
Remove the misleading 'legacy' label from the README intro and describe com.sumup:merchant-api as the artifact published in the SumUp Maven repository.\nThis keeps the recommended Android integration path explicit instead of implying that the documented dependency should be avoided.
Update the README badge and top-level documentation reference to point to docs.sumup.com, matching the current public README recommendations.\nKeep the restructured layout, but make the primary documentation destination consistent with the repository's existing guidance.
Point the README badge and top-level documentation reference back to developer.sumup.com.\nThis reverts the incorrect switch to docs.sumup.com while keeping the restructured README content intact.
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
1 participant
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.
Rewrite the README around the stable integration contract instead of the aging sample implementation details.
Update the Gradle snippets, fix broken Java examples, and separate recommended usage from legacy compatibility notes so integrators can modernize without changing the SumUp API surface.