Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kimar committed Jan 25, 2022
1 parent fcd267c commit 02d309e
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# KeychainWrapper

A description of this package.
A very simple wrapper around the iOS keychain.

## Usage

First instantiate `KeychainWrapper`, then use the instance to create, read or delete keychain entries, e.g.:

```swift
let keychainWrapper = KeychainWrapper(service: "myApp")

// store password <-> username mapping for service "myApp"
keychainWrapper["username"] = "secretPassword"

// retrieve password for username
let password = keychainWrapper["username"]

// delete password entry for username in service "myApp"
keychainWrapper["username"] = nil
```

## License

See [LICENSE.md](LICENSE.md).

0 comments on commit 02d309e

Please sign in to comment.