Update README.md

This commit is contained in:
Jeff Potter 2015-10-15 14:59:46 -06:00
parent f9bd317c34
commit 2de680518a
1 changed files with 14 additions and 4 deletions

View File

@ -1,6 +1,8 @@
SwiftValidator
===============
[![Build Status](https://travis-ci.org/jpotts18/SwiftValidator.svg?branch=travis-ci)](https://travis-ci.org/jpotts18/SwiftValidator)
Swift Validator is a rule-based validation library for Swift.
![Swift Validator](/swift-validator-v2.gif)
@ -11,7 +13,7 @@ Swift Validator is a rule-based validation library for Swift.
* ``UITextField`` + ``ValidationError`` come out of ``Validator``
* ``Validator`` evaluates ``[Rule]`` sequentially and stops evaluating when a ``Rule`` fails.
## Quick Start
## Installation
```ruby
# Podfile
@ -19,21 +21,29 @@ source 'https://github.com/CocoaPods/Specs.git'
platform :ios, "8.1"
use_frameworks!
pod 'SwiftValidator', '3.0.0'
pod 'SwiftValidator', '3.0.1'
```
Install into your project:
```
```bash
$ pod install
```
Open your project in Xcode from the .xcworkspace file (not the usual project file):
```
```bash
$ open MyProject.xcworkspace
```
If you are using Carthage you will need to add this to your `Cartfile`
```bash
github “jpotts18/SwiftValidator”
```
## Usage
You can now import SwiftValidator framework into your files.
Initialize the ``Validator`` by setting a delegate to a View Controller or other object.