Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
t0mball committed Mar 27, 2017
1 parent 0750e7c commit eaac521
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,15 @@ You can use [CocoaPods](http://cocoapods.org/) to install `SwiftyOnboard` by add
use_frameworks!
pod 'SwiftyOnboard'
```
If you get the ``Unable to find a specification for `SwiftyOnboard`.`` error after running `pod install`.

Run the following commands on your project directory:
```
pod repo update
```
```
pod install
```
#### Manually
1. Drag and drop ```SwiftyOnboard.swift``` ```SwiftyOnboardOverlay.swift``` ```SwiftyOnboardPage.swift``` in your project.
2. That's it!
Expand Down Expand Up @@ -88,7 +97,6 @@ extension ViewController: SwiftyOnboardDataSource {
<!-- [Example project with CocoaPods](https://github.com/juanpablofernandez). -->

### Properties
--------------

SwiftyOnboard has the following properties:
```swift
Expand All @@ -105,7 +113,6 @@ public var shouldSwipe: Bool
Whether or not swiping is enabled [default = true].

### Methods
--------------

SwiftyOnboard class has the following methods:
```swift
Expand All @@ -114,7 +121,6 @@ func goToPage(index: Int, animated: Bool)
This method allows you to move to a certain page in the onboarding.

### Protocols
---------------

The SwiftyOnboard follows the Apple convention for data-driven views by providing two protocol interfaces, SwiftyOnboardDataSource and SwiftyOnboardDelegate.
#### SwiftyOnboardDataSource
Expand Down

0 comments on commit eaac521

Please sign in to comment.