Updated readme

This commit is contained in:
Robert Payne 2015-04-12 22:36:02 +12:00
parent abf55da38b
commit 4c9de82dc0
1 changed files with 15 additions and 13 deletions

View File

@ -1,4 +1,7 @@
# Snap
<img src="https://raw.githubusercontent.com/Masonry/Snap/Assets/snap-banner.png" alt="">
====
[![Build Status](https://travis-ci.org/Masonry/Snap.svg)](https://travis-ci.org/Masonry/Snap) [![Build Status](https://travis-ci.org/Masonry/Snap.svg)](https://travis-ci.org/Masonry/Snap)
@ -32,7 +35,7 @@ source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0' platform :ios, '8.0'
use_frameworks! use_frameworks!
pod 'Snap', '~> 0.9.1' pod 'Snap', '~> 0.9.2'
``` ```
Then, run the following command: Then, run the following command:
@ -54,8 +57,8 @@ $ brew install carthage
To integrate Snap into your Xcode project using Carthage, specify it in your `Cartfile`: To integrate Snap into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl ```
github "Masonry/Snap" >= 0.9.1 github "Masonry/Snap" >= 0.9.2
``` ```
### Manually ### Manually
@ -141,19 +144,18 @@ Heres the same constraints created using ConstraintMaker
```swift ```swift
let padding = UIEdgeInsetsMake(10, 10, 10, 10) let padding = UIEdgeInsetsMake(10, 10, 10, 10)
view1.snp_makeConstraints { make in view1.snp_makeConstraints { (make) -> Void in
make.top.equalTo(superview.snp_top).with.offset(padding.top) // with is an optional semantic filler make.top.equalTo(superview.snp_top).offset(padding.top)
make.left.equalTo(superview.snp_left).with.offset(padding.left) make.left.equalTo(superview.snp_left).offset(padding.left)
make.bottom.equalTo(superview.snp_bottom).with.offset(-padding.bottom) make.bottom.equalTo(superview.snp_bottom).offset(-padding.bottom)
make.right.equalTo(superview.snp_right).with.offset(-padding.right) make.right.equalTo(superview.snp_right).offset(-padding.right)
} }
``` ```
Or even shorter Or even shorter
```swift ```swift
view1.snp_makeConstraints { make in view1.snp_makeConstraints { (make) -> Void in
make.edges.equalTo(superview).with.insets(padding) make.edges.equalTo(superview).insets(padding)
return // this return is a fix for implicit returns in Swift and is only required for single line constraints
} }
``` ```
@ -304,7 +306,7 @@ var topConstraint: Constraint? = nil
// when making constraints // when making constraints
view1.snp_makeConstraints { make in view1.snp_makeConstraints { make in
self.topConstraint = make.top.equalTo(superview).with.offset(padding.top) self.topConstraint = make.top.equalTo(superview).with.offset(padding.top).constraint
make.left.equalTo(superview).with.offset(padding.left) make.left.equalTo(superview).with.offset(padding.left)
} }