Skip to content

Commit 8ae2b45

Browse files
author
James Sherlock
committed
Update README
1 parent 43fca25 commit 8ae2b45

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
11
# SwiftyProvisioningProfile
22

3-
A description of this package.
3+
This library provides a way to decode a `.mobileprovision` file into a Swift model.
4+
5+
#### Installation
6+
7+
The recommended installation is via Swift Package Manager, you'll want to update your `Package.swift` with a new dependency:
8+
9+
```swift
10+
import PackageDescription
11+
12+
let package = Package(
13+
name: "YourAwesomeSoftware",
14+
dependencies: [
15+
.package(url: "https://github.com/Sherlouk/SwiftProvisioningProfile.git", from: "1.0.0")
16+
]
17+
)
18+
```
19+
20+
There are open issues to handle CocoaPods and Carthage installation, if people want it then I'm willing to support it!
21+
22+
#### Usage
23+
24+
```swift
25+
// 1. Import the library
26+
import SwiftyProvisioningProfile
27+
28+
// 2. Load your provisioning profile's file data
29+
let profileData = try Data(contentsOf: ...)
30+
31+
// 3. Parse it
32+
let profile = try ProvisioningProfile.parse(from: profileData)
33+
34+
// 4. Use it
35+
print(profile.uuid)
36+
```

0 commit comments

Comments
 (0)