Improve SolidusBraintree README - Githubissues

solidusio / solidus_braintree

💳 Integrate Solidus with Braintree

https://www.braintreepayments.com/

BSD 3-Clause "New" or "Revised" License

19 stars 55 forks source link

Improve SolidusBraintree README #125

Closed gsmendoza closed 1 year ago

gsmendoza commented 1 year ago

Summary

Closes https://github.com/solidusio/solidus_braintree/issues/123.

Goals

Provide overview of what README covers.
Improve navigability of README.
Tie SolidusBraintree payment options to corresponding Braintree documentation.
Add section for Credit card payment and Hosted Fields solution.

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

[x] I have written a thorough PR description.
[x] I have kept my commits small and atomic.
[x] I have used clear, explanatory commit messages.

The following are not always needed:

📖 I have updated the README to account for my changes.
📑 I have documented new code with YARD.
🛣️ I have opened a PR to update the guides.
✅ I have added automated tests to cover my changes.
📸 I have attached screenshots to demo visual changes.

gsmendoza commented 1 year ago

@kennyadsl Can you review? If you have other ideas on how we can improve the README, please let me know. Thanks!

gsmendoza commented 1 year ago

@kennyadsl @kennyadsl I rebased the PR and made two changes:

Replaced the TOC with a list of the payment method types.
Added a compatibility section.

Appreciate if you can take one more look! Thanks!