From 029b354afff6fb65ee58f9c9f04bc3e4e94d0bed Mon Sep 17 00:00:00 2001
From: Rita Zerrizuela
Date: Thu, 14 Dec 2023 02:52:01 +0000
Subject: [PATCH] Use the new syntax for Markdown admonitions (#200)
---
CONTRIBUTING.md | 2 +-
EXAMPLES.md | 8 ++++----
README.md | 4 ++--
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 02a24e6..8a2f2ee 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Contributing
-> **Note**
+> [!IMPORTANT]
> 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
diff --git a/EXAMPLES.md b/EXAMPLES.md
index 3838509..dbf5ab6 100644
--- a/EXAMPLES.md
+++ b/EXAMPLES.md
@@ -34,7 +34,7 @@ When creating the SimpleKeychain instance, specify the access group that the app
let simpleKeychain = SimpleKeychain(accessGroup: "ABCDEFGH.com.example.myaccessgroup")
```
-> **Note**
+> [!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
@@ -45,7 +45,7 @@ When creating the SimpleKeychain instance, set `synchronizable` to `true` to ena
let simpleKeychain = SimpleKeychain(sychronizable: true)
```
-> **Note**
+> [!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
@@ -56,7 +56,7 @@ When creating the SimpleKeychain instance, specify a custom accesibility value t
let simpleKeychain = SimpleKeychain(accessibility: .whenUnlocked)
```
-> **Note**
+> [!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
@@ -70,7 +70,7 @@ let simpleKeychain = SimpleKeychain(accessControlFlags: .biometryCurrentSet,
context: context)
```
-> **Note**
+> [!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).
---
diff --git a/README.md b/README.md
index 8e217b1..3959d1d 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ Migrating from 0.x? Check the [Migration Guide](V1_MIGRATION_GUIDE.md).
- Xcode 13.x / 14.x
- Swift 5.x
-> **Note**
+> [!IMPORTANT]
> Check the [Support Policy](#support-policy) to learn when dropping Xcode, Swift, and platform versions will not be considered a **breaking change**.
### Installation
@@ -187,6 +187,6 @@ Please do not report security vulnerabilities on the public GitHub issue tracker
-Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
+Auth0 is an easy-to-implement, adaptable authentication and authorization platform. To learn more check out Why Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.