Skip to content

Commit eb9b1aa

Browse files
authored
Update README.md
Add notes about (lack of) Carthage support.
1 parent 717f3d6 commit eb9b1aa

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ pod 'Poly', :git => 'https://github.com/mattpolzin/Poly.git'
7979
pod 'MP-JSONAPI', :git => 'https://github.com/mattpolzin/JSONAPI.git'
8080
```
8181

82+
### Carthage
83+
This library does not support the Carthage package manager. This is intentional to avoid an additional dependency on Xcode and the Xcode's project files as their format changes throughout versions (in addition to the complexity of maintaining different shared schemes for each supported operating system).
84+
85+
The difference between supporting and not supporting Carthage is the difference between maintaining an Xcode project with at least one shared build scheme; I encourage those that need Carthage support to fork this repository and add support to their fork by committing an Xcode project (you can generate one as described in the [Xcode project](#xcode-project) section above). Once an Xcode project is generated, you need to mark at least one scheme as [shared](https://github.com/Carthage/Carthage#share-your-xcode-schemes).
86+
8287
### Running the Playground
8388
To run the included Playground files, create an Xcode project using Swift Package Manager, then create an Xcode Workspace in the root of the repository and add both the generated Xcode project and the playground to the Workspace.
8489

0 commit comments

Comments
 (0)