Skip to content

INSTALL.md

Latest commit

 

History

History
113 lines (74 loc) · 2.65 KB

INSTALL.md

File metadata and controls

113 lines (74 loc) · 2.65 KB

DefaultsKit

UserDefaults for iOS, macOS and tvOS.

Usage >> instructions <<

Installation

CocoaPods

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To give DefaultsKit a try with an example project, run the following command:

$ pod try DefaultsKit

To integrate DefaultsKit into your Xcode project, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
  pod 'DefaultsKit'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a dependency manager that builds your dependencies and provides you with binary frameworks.

To install Carthage with Homebrew use the following command:

$ brew update
$ brew install carthage

To integrate DefaultsKit into your Xcode project using Carthage, specify it in your Cartfile:

github "nmdias/DefaultsKit"

Build the framework:

$ carthage update

Then, drag the built DefaultsKit.framework into your Xcode project.

Swift Package Manager

"The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies."

To integrate DefaultsKit into your project, specify it in your Package.swift file:

let package = Package(
    name: "MyApp",
    dependencies: [
        .Package(url: "https://github.com/nmdias/DefaultsKit.git")
    ]
)

Then run:

$ swift build

Or, alternatively:

$ swift package generate-xcodeproj

Manually

Drag DefaultsKit.xcodeproj into your Xcode project.

It should appear nested underneath your application's blue project icon.

Click on the + button under the "Embedded Binaries" section of your app's target and select the DefaultsKit.framework that matches the desired platform.

Credits

Similarities to Alamofire's impecable setup instructions are not a coincidence :)

License

DefaultsKit is released under the MIT license. See LICENSE for details.