-
Notifications
You must be signed in to change notification settings - Fork 9
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
4 changed files
with
106 additions
and
15 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 |
---|---|---|
@@ -1 +1,80 @@ | ||
# SwiftyConfiguration | ||
# SwiftyConfiguration | ||
|
||
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) | ||
[![Pod Version](http://img.shields.io/cocoapods/v/SwiftyConfiguration.svg?style=flat)](http://cocoadocs.org/docsets/SwiftyConfiguration/) | ||
[![Pod Platform](http://img.shields.io/cocoapods/p/SwiftyConfiguration.svg?style=flat)](http://cocoadocs.org/docsets/SwiftyConfiguration/) | ||
[![Pod License](http://img.shields.io/cocoapods/l/SwiftyConfiguration.svg?style=flat)](https://github.com/ykyohei/SwiftyConfiguration/blob/master/LICENSE) | ||
![Swift version](https://img.shields.io/badge/swift-2.2-orange.svg) | ||
|
||
SwiftyConfiguration is modern Swift API for Plist. | ||
|
||
|
||
## Usage | ||
|
||
##### 1. Create Plist | ||
create plist file and add your project. | ||
|
||
![plist.png](./Images/plist.png "plist.png") | ||
|
||
##### 2. Define your plist keys | ||
```Swift | ||
extension Keys { | ||
static let string = Key<String>("string") | ||
static let url = Key<NSURL>("url") | ||
static let number = Key<NSNumber>("number") | ||
static let int = Key<Int>("int") | ||
static let float = Key<Float>("float") | ||
static let double = Key<Double>("double") | ||
static let date = Key<NSDate>("date") | ||
static let bool = Key<Bool>("bool") | ||
static let array = Key<Array<AnyObject>>("array") | ||
static let dictionary = Key<[String : String]>("dictionary") | ||
|
||
// Support nested value. | ||
static let innerInt = Key<Int>("array.0") | ||
static let innerArray = Key<String>("array.1.0") | ||
static let innerString = Key<String>("dictionary.innerString") | ||
} | ||
``` | ||
|
||
##### 3. Just use it! | ||
```Swift | ||
let plistPath = NSBundle.mainBundle().pathForResource("Configuration", ofType: "plist")! | ||
let config = Configuration(plistPath: plistPath)! | ||
|
||
// You can get a plist value to type-safe. | ||
let stringValue = config.get(.string)! | ||
let urlValue = config.get(.url)! | ||
let numberValue = config.get(.number)! | ||
let intValue = config.get(.int)! | ||
let floatValue = config.get(.float)! | ||
let doubleValue = config.get(.double)! | ||
let dateValue = config.get(.date)! | ||
let boolValue = config.get(.bool)! | ||
let arrayValue = config.get(.array)! | ||
let dictionaryValue = config.get(.dictionary)! | ||
let innerIntValue = config.get(.innerInt)! | ||
let innerArrayValue = config.get(.innerArray)! | ||
let innerStringValue = config.get(.innerString)! | ||
``` | ||
|
||
## Installation | ||
|
||
### Carthage | ||
`SwiftyConfiguration` is available through [Carthage](https://github.com/Carthage/Carthage). To install it, simply add the following line to your Cartfile: | ||
|
||
```ruby | ||
github "ykyouhei/SwiftyConfiguration" | ||
``` | ||
|
||
### CocoaPods | ||
|
||
`SwiftyConfiguration` is available on CocoaPods. | ||
Add the following to your `Podfile`: | ||
|
||
```ruby | ||
pod 'SwiftyConfiguration' | ||
``` | ||
|
||
### Manually | ||
Just add the Classes folder to your project. |
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
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
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