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

Add supported platform to README #693

Merged
merged 3 commits into from
Feb 19, 2018
Merged

Add supported platform to README #693

merged 3 commits into from
Feb 19, 2018

Conversation

funkyboy
Copy link
Contributor

Fix #692

Copy link
Member

@paddybyers paddybyers left a comment

Choose a reason for hiding this comment

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

Typo: The following platforms.

So if someone builds an app embedding this library will that app fail to install on iOS8? Will it run but possibly fail at runtime?

I think a statement about platform support needs to be explicit about what it means for a platform to be unsupported.

@funkyboy
Copy link
Contributor Author

funkyboy commented Feb 19, 2018

@paddybyers Technically I didn't drop the compatibility with iOS8 yet in the configuration. So it will "work", as in compile and not throw runtime errors.

I am afraid the message in the README can be quite long:

  • we are not breaking compatibility with iOS8 on purpose
  • but we are not running tests on iOS8
  • so we don't know how it behaves on that platform
  • and if you spot a bug specific to iOS8 it's likely that we are not going to fix it, or give it low priority.

I'd keep the positive version: "we support x, y and z". Or even "this SDK is compatible with iOS9 and above".
Firebase for example says "An Xcode project targeting iOS 8 or above".

@paddybyers
Copy link
Member

paddybyers commented Feb 19, 2018

I'd keep the positive version: "we support x, y and z". Or even "this SDK is compatible with iOS9 and above".

OK, fine. If we later we or customers find things that are broken on earlier versions we can decide whether we explicitly state that it is not compatible with iOS 8, or we have a statement that says something like "some features are not available on earlier iOS versions; see <issue>".

@funkyboy
Copy link
Contributor Author

@paddybyers Improved again the description.

Copy link
Member

@paddybyers paddybyers left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@funkyboy funkyboy merged commit 5c13004 into master Feb 19, 2018
@funkyboy funkyboy deleted the add-supported-platform branch February 19, 2018 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants