Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #458

Closed
wants to merge 6 commits into from
Closed

Updated README.md #458

wants to merge 6 commits into from

Conversation

stechiu
Copy link
Contributor

@stechiu stechiu commented Dec 11, 2024

Summary of changes

  • Updated README on SDK deprecation

Checklist

  • Added a changelog entry

Authors

List GitHub usernames for everyone who contributed to this pull request.

@stechiu stechiu requested a review from a team as a code owner December 11, 2024 23:36
README.md Show resolved Hide resolved
@@ -11,6 +11,18 @@ Welcome to Braintree's Drop-in SDK for iOS!

**The Braintree iOS Drop-in SDK permits a deployment target of iOS 12.0 or higher.** It requires Xcode 15.0+ and Swift 5.9+.

## 📣 Announcements

Choose a reason for hiding this comment

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

Would it make sense to move the announcement to top of README?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1, we should put this up in lights as clearly as possible

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe even some scary-looking alarm emojis, or things to grab people's eye.

What about also updating the repo description with some warning message?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was thinking about that since someone needs to scroll past the image to see the announcement

README.md Outdated
@@ -11,6 +11,16 @@ Welcome to Braintree's Drop-in SDK for iOS!

**The Braintree iOS Drop-in SDK permits a deployment target of iOS 12.0 or higher.** It requires Xcode 15.0+ and Swift 5.9+.

## 📣 Announcements

**The iOS Drop-In SDK is currently inactive and will be unsupported by November 2025**. As of December 2024, the iOS Drop-In SDK is inactive. No additional features will be added with the exception of security updates. As an alternative, we recommend using the ![Braintree SDK](https://github.com/braintree/braintree_ios) for unbranded checkout.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit / take it or leave it - instead of "recommend" (which suggests they maybe look to another provider) do we want to say something like

"Instead, implement a custom UI using braintree_ios"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, will add that to be more specific

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I add that we are no longer addressing bugs? or leave it at "no additional features will be added"?

I changed the last sentence to say "Instead, implement a custom UI using the Braintree SDK (braintree_ios)." Open to feedback about the wording

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
stechiu and others added 2 commits December 17, 2024 09:15
Co-authored-by: Jax DesMarais-Leder <[email protected]>
Co-authored-by: Jax DesMarais-Leder <[email protected]>
@stechiu
Copy link
Contributor Author

stechiu commented Dec 17, 2024

Closing for now until team comes to conclusion about communication timelines

@stechiu stechiu closed this Dec 17, 2024
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.

5 participants