Skip to content

Commit

Permalink
Merge pull request #586 from kishikawakatsumi/remove-screenshots
Browse files Browse the repository at this point in the history
Remove screenshots
  • Loading branch information
kishikawakatsumi committed Nov 12, 2023
2 parents 2b4b209 + ac72b0b commit 6df250d
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@

KeychainAccess is a simple Swift wrapper for Keychain that works on iOS and macOS. Makes using Keychain APIs extremely easy and much more palatable to use in Swift.

<img src="https://raw.githubusercontent.com/kishikawakatsumi/KeychainAccess/master/Screenshots/01.png" width="320px" />
<img src="https://raw.githubusercontent.com/kishikawakatsumi/KeychainAccess/master/Screenshots/02.png" width="320px" />
<img src="https://raw.githubusercontent.com/kishikawakatsumi/KeychainAccess/master/Screenshots/03.png" width="320px" />
<img src="https://github.com/kishikawakatsumi/KeychainAccess/assets/40610/4de4aae1-6fc1-4477-af6d-afbe6d164da0" width="320px" /> <img src="https://github.com/kishikawakatsumi/KeychainAccess/assets/40610/2980ea84-862b-4067-b9b7-90de629171b9" width="320px" />
<img src="https://github.com/kishikawakatsumi/KeychainAccess/assets/40610/3299347d-eb1b-446c-921c-778fa493f818" width="320px" />

## :bulb: Features

Expand All @@ -27,7 +26,8 @@ KeychainAccess is a simple Swift wrapper for Keychain that works on iOS and macO

## :book: Usage

##### :eyes: See also:
##### :eyes: See also:

- [:link: iOS Example Project](https://github.com/kishikawakatsumi/KeychainAccess/tree/master/Examples/Example-iOS)

### :key: Basics
Expand Down Expand Up @@ -324,12 +324,11 @@ do {
**Any Operation that require authentication must be run in the background thread.**
**If you run in the main thread, UI thread will lock for the system to try to display the authentication dialog.**


**To use Face ID, add `NSFaceIDUsageDescription` key to your `Info.plist`**

#### :closed_lock_with_key: Adding a Touch ID (Face ID) protected item

If you want to store the Touch ID protected Keychain item, specify `accessibility` and `authenticationPolicy` attributes.
If you want to store the Touch ID protected Keychain item, specify `accessibility` and `authenticationPolicy` attributes.

```swift
let keychain = Keychain(service: "com.example.github-token")
Expand All @@ -348,7 +347,7 @@ DispatchQueue.global().async {

#### :closed_lock_with_key: Updating a Touch ID (Face ID) protected item

The same way as when adding.
The same way as when adding.

**Do not run in the main thread if there is a possibility that the item you are trying to add already exists, and protected.**
**Because updating protected items requires authentication.**
Expand Down Expand Up @@ -412,8 +411,7 @@ do {
### <a name="shared_web_credentials"> :key: Shared Web Credentials

> Shared web credentials is a programming interface that enables native iOS apps to share credentials with their website counterparts. For example, a user may log in to a website in Safari, entering a user name and password, and save those credentials using the iCloud Keychain. Later, the user may run a native app from the same developer, and instead of the app requiring the user to reenter a user name and password, shared web credentials gives it access to the credentials that were entered earlier in Safari. The user can also create new accounts, update passwords, or delete her account from within the app. These changes are then saved and used by Safari.
<https://developer.apple.com/library/ios/documentation/Security/Reference/SharedWebCredentialsRef/>
> <https://developer.apple.com/library/ios/documentation/Security/Reference/SharedWebCredentialsRef/>
```swift
let keychain = Keychain(server: "https://www.kishikawakatsumi.com", protocolType: .HTTPS)
Expand Down Expand Up @@ -546,7 +544,7 @@ OSStatus error:[-34018] Internal error when a required entitlement isn't present
## Requirements

| | OS | Swift |
|------------|------------------------------------------------------------|--------------------|
| ---------- | ---------------------------------------------------------- | ------------------ |
| **v1.1.x** | iOS 7+, macOS 10.9+ | 1.1 |
| **v1.2.x** | iOS 7+, macOS 10.9+ | 1.2 |
| **v2.0.x** | iOS 7+, macOS 10.9+, watchOS 2+ | 2.0 |
Expand Down Expand Up @@ -585,7 +583,7 @@ KeychainAccess is also available through [Swift Package Manager](https://github.

#### Xcode

Select `File > Add Packages... > Add Package Dependency...`,
Select `File > Add Packages... > Add Package Dependency...`,

<img src="https://user-images.githubusercontent.com/40610/67627000-2833b580-f88f-11e9-89ef-18819b1a6c67.png" width="800px" />

Expand Down Expand Up @@ -625,7 +623,7 @@ $ swift build

_See [iOS Example Project](https://github.com/kishikawakatsumi/KeychainAccess/tree/master/Examples/Example-iOS) as reference._

<img src="https://raw.githubusercontent.com/kishikawakatsumi/KeychainAccess/master/Screenshots/Installation.png" width="800px" />
<img src="https://github.com/kishikawakatsumi/KeychainAccess/assets/40610/b7a46cfb-714d-47d5-84ea-6a80f640e03d" width="800px" />

## Author

Expand Down
Binary file removed Screenshots/01.png
Binary file not shown.
Binary file removed Screenshots/02.png
Binary file not shown.
Binary file removed Screenshots/03.png
Binary file not shown.
Binary file removed Screenshots/Installation.png
Binary file not shown.

0 comments on commit 6df250d

Please sign in to comment.