Skip to content

Commit 01e22dc

Browse files
authored
Merge pull request #18 from mattrubin/installation-instructions
Add installation instructions to the README
2 parents 666cb96 + a823fcd commit 01e22dc

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,54 @@ struct Comment: Equatable, Codable {
2929
}
3030
```
3131

32+
33+
## Installation
34+
35+
### [Carthage][]
36+
37+
Add the following line to your [Cartfile][]:
38+
39+
````config
40+
github "mattrubin/Identifier" ~> 0.1
41+
````
42+
43+
Then run `carthage update Identifier` to install the latest version of the framework.
44+
45+
Be sure to check the Carthage README file for the latest instructions on [adding frameworks to an application][carthage-instructions].
46+
47+
[Carthage]: https://github.com/Carthage/Carthage
48+
[Cartfile]: https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile
49+
[carthage-instructions]: https://github.com/Carthage/Carthage/blob/master/README.md#adding-frameworks-to-an-application
50+
51+
### [CocoaPods][]
52+
53+
Add the following line to your [Podfile][]:
54+
55+
````ruby
56+
pod 'Identifier', '~> 0.1'
57+
````
58+
59+
Identifier, like all pods written in Swift, can only be integrated as a framework. Make sure to add the line `use_frameworks!` to your Podfile or target to opt into frameworks instead of static libraries.
60+
61+
Then run `pod install` to install the latest version of the framework.
62+
63+
[CocoaPods]: https://cocoapods.org
64+
[Podfile]: https://guides.cocoapods.org/using/the-podfile.html
65+
66+
### [SPM][]
67+
68+
Add the following line to the dependencies section of your [package manifest][Package.swift]:
69+
70+
```swift
71+
.package(url: "https://github.com/mattrubin/Identifier.git", from: "0.1.0"),
72+
```
73+
74+
Then add `"Identifier"` to the dependencies array of any target which should be linked with this library
75+
76+
[SPM]: https://swift.org/package-manager/
77+
[Package.swift]: https://github.com/apple/swift-package-manager/tree/master/Documentation
78+
79+
3280
## License
3381

3482
Identifier is released under the [MIT License](LICENSE.md).

0 commit comments

Comments
 (0)