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.

Sign up for GitHub

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

Use the new syntax for Markdown admonitions #200

Merged
merged 2 commits into from
Dec 14, 2023
Merged

Use the new syntax for Markdown admonitions #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b6fbce
Use the new syntax for Markdown admonitions
Widcket Dec 13, 2023
a5729b9
Apply Grammarly suggestion
Widcket Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions EXAMPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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).

---
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -187,6 +187,6 @@ Please do not report security vulnerabilities on the public GitHub issue tracker
</picture>
</p>

<p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
<p align="center">Auth0 is an easy-to-implement, adaptable authentication and authorization platform. To learn more check out <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>

<p align="center">This project is licensed under the MIT license. See the <a href="./LICENSE"> LICENSE</a> file for more info.</p>