-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
2,285 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
|
||
# PropertyKit | ||
|
||
[UserDefaults](https://developer.apple.com/documentation/foundation/userdefaults) for iOS, macOS and tvOS. | ||
|
||
Usage >> [`instructions`](https://github.com/metasmile/PropertyKit/blob/master/README.md) << | ||
|
||
## Installation | ||
- [CocoaPods](#cocoapods) | ||
- [Carthage](#carthage) | ||
- [Swift Package Manager](#swift-package-manager) | ||
- [Manually](#manually) | ||
|
||
# | ||
|
||
### CocoaPods | ||
|
||
[CocoaPods](http://cocoapods.org) is a dependency manager for Swift and Objective-C Cocoa projects. You can install it with the following command: | ||
|
||
```bash | ||
$ gem install cocoapods | ||
``` | ||
|
||
To give `PropertyKit` a try with an example project, run the following command: | ||
|
||
```bash | ||
$ pod try PropertyKit | ||
``` | ||
|
||
To integrate `PropertyKit` into your Xcode project, specify it in your `Podfile`: | ||
|
||
```ruby | ||
source 'https://github.com/CocoaPods/Specs.git' | ||
platform :ios, '8.0' | ||
use_frameworks! | ||
|
||
target 'MyApp' do | ||
pod 'PropertyKit' | ||
end | ||
``` | ||
|
||
Then, run the following command: | ||
|
||
```bash | ||
$ pod install | ||
``` | ||
|
||
### Carthage | ||
|
||
[Carthage](https://github.com/Carthage/Carthage) is a dependency manager that builds your dependencies and provides you with binary frameworks. | ||
|
||
To install Carthage with [Homebrew](http://brew.sh/) use the following command: | ||
|
||
```bash | ||
$ brew update | ||
$ brew install carthage | ||
``` | ||
To integrate PropertyKit into your Xcode project using Carthage, specify it in your `Cartfile`: | ||
|
||
```ogdl | ||
github "metasmile/PropertyKit" | ||
``` | ||
Build the framework: | ||
|
||
```bash | ||
$ carthage update | ||
``` | ||
Then, drag the built `PropertyKit.framework` into your Xcode project. | ||
|
||
### Swift Package Manager | ||
|
||
"The [Swift Package Manager](https://swift.org/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 `PropertyKit` into your project, specify it in your `Package.swift` file: | ||
|
||
```swift | ||
let package = Package( | ||
name: "MyApp", | ||
dependencies: [ | ||
.Package(url: "https://github.com/metasmile/PropertyKit.git") | ||
] | ||
) | ||
``` | ||
|
||
Then run: | ||
|
||
```bash | ||
$ swift build | ||
``` | ||
|
||
Or, alternatively: | ||
|
||
```bash | ||
$ swift package generate-xcodeproj | ||
``` | ||
|
||
### Manually | ||
|
||
Drag `PropertyKit.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 `PropertyKit.framework` that matches the desired platform. | ||
|
||
## Credits | ||
Similarities to [Alamofire](https://github.com/Alamofire/Alamofire)'s impecable setup instructions are not a coincidence :) | ||
|
||
## License | ||
|
||
PropertyKit is released under the MIT license. See [LICENSE](https://github.com/metasmile/PropertyKit/blob/master/LICENSE) for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import PackageDescription | ||
|
||
let package = Package( | ||
name: "PropertyKit", | ||
dependencies : [], | ||
exclude: ["Tests"] | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
Pod::Spec.new do |s| | ||
s.name = 'PropertyKit' | ||
s.version = '1.0' | ||
s.license = 'MIT' | ||
s.swift_version = '4.0' | ||
s.summary = 'Protocol-First, Type and Key-Safe Swift Property for iOS, macOS and tvOS.' | ||
s.homepage = 'https://github.com/metasmile/PropertyKit' | ||
s.authors = { 'Taeho Lee' => '[email protected]' } | ||
s.source = { :git => 'https://github.com/metasmile/PropertyKit.git', :tag => s.version } | ||
s.ios.deployment_target = '10.0' | ||
s.osx.deployment_target = '10.10' | ||
s.tvos.deployment_target = '9.0' | ||
s.watchos.deployment_target = '2.0' | ||
s.source_files = 'Sources/**/*.swift' | ||
end |
Oops, something went wrong.