Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updating readme

  • Loading branch information...
commit b1d15e831fef0f7ab067f7501b4041c9e2508ab7 1 parent 4a2e37a
@samus authored
Showing with 13 additions and 3 deletions.
  1. +13 −3 README.md
View
16 README.md
@@ -3,14 +3,24 @@
[![Version](http://cocoapod-badges.herokuapp.com/v/SYNParallaxScrollObserver/badge.png)](http://cocoadocs.org/docsets/SYNParallaxScrollObserver)
[![Platform](http://cocoapod-badges.herokuapp.com/p/SYNParallaxScrollObserver/badge.png)](http://cocoadocs.org/docsets/SYNParallaxScrollObserver)
-## Usage
-
-To run the example project; clone the repo, and run `pod install` from the Project directory first.
+SYNParallaxScrollObserver is a class that observes the content offset of one scrollview and applies a parallaxed version of the offset to another scrollview.
![Alt text](/Readme_Images/parallaxdemo1.png "Scroll start")
![Alt text](/Readme_Images/parallaxdemo2.png "Scrolling")
Note: This library doesn't apply the blur shown in the screenshots but the example project shows how it can be done.
+
+## Usage
+
+To run the example project; clone the repo, and run `pod install` from the Project directory first.
+
+Using in a project can be done with the following code.
+
+``` objc
+ self.parallaxObserver = [[SYNParallaxScrollObserver alloc] initWithObservedScrollView:self.observed parallaxedScrollView:self.parallaxed];
+ [self.parallaxObserver startObserving];
+```
+
## Requirements
## Installation

0 comments on commit b1d15e8

Please sign in to comment.
Something went wrong with that request. Please try again.