From 2a83078629a20ca929e28271c04b2df8636c324b Mon Sep 17 00:00:00 2001 From: Patrick Balestra Date: Thu, 14 Mar 2019 23:33:19 +0100 Subject: [PATCH] Add dependency managers installation instructions to README --- README.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4f8eacd4..421582d8 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,36 @@ This repository contains the core Mobius framework and add-ons for common develo | 🛠 Xcode | 10.1+ | | 🐦 Language | Swift 4.2 | -## Usage in Your Project -Pull in Mobius.swift as a dependency. Either as a submodule or using [Carthage](https://github.com/Carthage/Carthage). +## Installation -Build the project and link with the frameworks. +Mobius.swift supports most popular dependency managers. Choose your preferred method to see the instructions: + +
CocoaPods + +Add the following entry in your `Podfile`: +```ruby +pod 'Mobius.swift' +``` +
+ +
Carthage + +Add the following entry in your `Cartfile`: +``` +github "spotify/Mobius.swift" +``` + +There are some additional steps to take as explained in the [Carthage documentation](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application). +>NOTE: At this moment Carthage doesn't have a way to specify subspecs in a single repo. For this reason, Carthage will automatically pull our dependencies used to provide test helpers in `MobiusNimble`. You can simply choose not to link this library in your project if you don't plan to use it. +
+ +
Swift Package Manager + +Add the following entry to your `Package.swift`: +```swift +.package(url: "https://github.com/spotify/Mobius.swift.git", .upToNextMajor(from: "0.1.0-alpha")) +``` +
## Mobius in Action - Building a Counter