Skip to content

Commit

Permalink
Use the new GitHub admonitions (#177)
Browse files Browse the repository at this point in the history
  • Loading branch information
Widcket committed Nov 11, 2022
1 parent 434ec46 commit 93d605d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Contributing

> ⚠️ Tests must be added for all new functionality. Existing tests must be updated for all changed/fixed functionality, where applicable. All tests must complete without errors. All new functionality must be documented as well.
> **Note**
> Tests must be added for all new functionality. Existing tests must be updated for all changed/fixed functionality, where applicable. All tests must complete without errors. All new functionality must be documented as well.
## Environment setup

Expand Down
12 changes: 8 additions & 4 deletions EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ When creating the SimpleKeychain instance, specify the access group that the app
let simpleKeychain = SimpleKeychain(accessGroup: "ABCDEFGH.com.example.myaccessgroup")
```

> 💡 For more information on access group sharing, see [Sharing Access to Keychain Items Among a Collection of Apps](https://developer.apple.com/documentation/security/keychain_services/keychain_items/sharing_access_to_keychain_items_among_a_collection_of_apps).
> **Note**
> For more information on access group sharing, see [Sharing Access to Keychain Items Among a Collection of Apps](https://developer.apple.com/documentation/security/keychain_services/keychain_items/sharing_access_to_keychain_items_among_a_collection_of_apps).
## Share items with other devices through iCloud synchronization

Expand All @@ -44,7 +45,8 @@ When creating the SimpleKeychain instance, set `synchronizable` to `true` to ena
let simpleKeychain = SimpleKeychain(sychronizable: true)
```

> 💡 For more information on iCloud synchronization, check the [kSecAttrSynchronizable documentation](https://developer.apple.com/documentation/security/ksecattrsynchronizable).
> **Note**
> For more information on iCloud synchronization, check the [kSecAttrSynchronizable documentation](https://developer.apple.com/documentation/security/ksecattrsynchronizable).
## Restrict item accessibility based on device state

Expand All @@ -54,7 +56,8 @@ When creating the SimpleKeychain instance, specify a custom accesibility value t
let simpleKeychain = SimpleKeychain(accessibility: .whenUnlocked)
```

> 💡 For more information on accessibility, see [Restricting Keychain Item Accessibility](https://developer.apple.com/documentation/security/keychain_services/keychain_items/restricting_keychain_item_accessibility).
> **Note**
> For more information on accessibility, see [Restricting Keychain Item Accessibility](https://developer.apple.com/documentation/security/keychain_services/keychain_items/restricting_keychain_item_accessibility).
## Require Touch ID / Face ID to retrieve an item

Expand All @@ -67,7 +70,8 @@ let simpleKeychain = SimpleKeychain(accessControlFlags: .biometryCurrentSet,
context: context)
```

> 💡 For more information on access control, see [Restricting Keychain Item Accessibility](https://developer.apple.com/documentation/security/keychain_services/keychain_items/restricting_keychain_item_accessibility).
> **Note**
> For more information on access control, see [Restricting Keychain Item Accessibility](https://developer.apple.com/documentation/security/keychain_services/keychain_items/restricting_keychain_item_accessibility).
---

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Migrating from 0.x? Check the [Migration Guide](V1_MIGRATION_GUIDE.md).
- Xcode 13.x / 14.x
- Swift 5.x

> ⚠️ Check the [Support Policy](#support-policy) to learn when dropping Xcode, Swift, and platform versions will not be considered a **breaking change**.
> **Note**
> Check the [Support Policy](#support-policy) to learn when dropping Xcode, Swift, and platform versions will not be considered a **breaking change**.
### Installation

Expand Down

0 comments on commit 93d605d

Please sign in to comment.