Add README documentation explaining that the keychain sharing entitlement is required#216
Merged
Add README documentation explaining that the keychain sharing entitlement is required#216
Conversation
Codecov Report
@@ Coverage Diff @@
## master #216 +/- ##
=======================================
Coverage 76.13% 76.13%
=======================================
Files 15 15
Lines 1060 1060
=======================================
Hits 807 807
Misses 253 253 |
fdiaz
approved these changes
Jan 27, 2020
README.md
Outdated
| ### Supporting macOS Catalina (10.15) and later | ||
| ### Integrating Valet into a macOS application | ||
|
|
||
| Your macOS application must have the Keychain Sharing entitlement in order to use Valet, even if your application does not intend to share keychain data between applications. For instructions on how to add a Keychain Sharing entitlement to your application, read [Apple's documentation on the subject](https://developer.apple.com/documentation/security/keychain_services/keychain_items/sharing_access_to_keychain_items_among_a_collection_of_apps). The subsection on "Add Apps to One or More Keychain Access Groups" is particularly helpful, as it includes a screenshot showing Xcode's Signing & Capabilities screen. For more information on why this requirement exists, see [issue #213](https://github.com/square/Valet/issues/213). |
Collaborator
There was a problem hiding this comment.
You can use https://developer.apple.com/documentation/security/keychain_services/keychain_items/sharing_access_to_keychain_items_among_a_collection_of_apps#2974918 to link directly to the "Add Apps to One or More Keychain Access Groups"` section
Collaborator
Author
There was a problem hiding this comment.
That's way better! When you have a chance, I'd love to know how you generated that link. I tried to find link anchors on that page but came up short.
Collaborator
There was a problem hiding this comment.
I just inspected the HTML 😁
Collaborator
Author
There was a problem hiding this comment.
Smart!! I'm going to have to steal that trick.
dfed
force-pushed
the
dfed--catalina-readme-update
branch
from
770531e to
6fb2926
Compare
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
3 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.
This PR should resolve #213.
cc @gregcotten