Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dfed committed Oct 21, 2024
1 parent 23bad01 commit 1bb6943
Showing 1 changed file with 10 additions and 38 deletions.
48 changes: 10 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,22 @@ Valet lets you securely store data in the iOS, tvOS, watchOS, or macOS Keychain

## Getting Started

### CocoaPods

Install with [CocoaPods](http://cocoapods.org) by adding the following to your `Podfile`:

on iOS:

```
platform :ios, '12.0'
use_frameworks!
pod 'Valet'
```
### Swift Package Manager

on tvOS:
Install with [Swift Package Manager](https://github.com/apple/swift-package-manager) by adding the following to your `Package.swift`:

```swift
dependencies: [
.package(url: "https://github.com/Square/Valet", from: "5.0.0"),
],
```
platform :tvos, '12.0'
use_frameworks!
pod 'Valet'
```

on watchOS:

```
platform :watchos, '4.0'
use_frameworks!
pod 'Valet'
```
### CocoaPods

on macOS:
Install with [CocoaPods](http://cocoapods.org) by adding the following to your `Podfile`:

```
platform :osx, '10.13'
use_frameworks!
pod 'Valet'
pod 'Valet', '~> 5.0.0'
```

### Carthage
Expand All @@ -58,23 +40,13 @@ github "Square/Valet"

Run `carthage` to build the framework and drag the built `Valet.framework` into your Xcode project.

### Swift Package Manager

Install with [Swift Package Manager](https://github.com/apple/swift-package-manager) by adding the following to your `Package.swift`:

```swift
dependencies: [
.package(url: "https://github.com/Square/Valet", from: "5.0.0"),
],
```

### Submodules

Or manually checkout the submodule with `git submodule add [email protected]:Square/Valet.git`, drag Valet.xcodeproj to your project, and add Valet as a build dependency.

## Usage

Prefer to learn via watching a video? Check out [this video tutorial](https://www.youtube.com/watch?v=E2Z8BBARlvs&list=PL_csAAO9PQ8Z9QxzfRxpN1YrVHXmncTSU&index=3).
Prefer to learn via watching a video? Check out [this video tutorial](https://www.youtube.com/watch?v=E2Z8BBARlvs&list=PL_csAAO9PQ8Z9QxzfRxpN1YrVHXmncTSU&index=3). Note that this video was recorded during the Valet 4 release.

### Basic Initialization

Expand Down

0 comments on commit 1bb6943

Please sign in to comment.