Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
s1m-0n committed Apr 19, 2016
1 parent b738b18 commit 316882d
Showing 1 changed file with 66 additions and 1 deletion.
67 changes: 66 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,67 @@
# NDParallaxIntroView
Easy to use Intro for introducing your App on first launch.

[![CI Status](http://img.shields.io/travis/Simon Wicha/NDParallaxIntroView.svg?style=flat)](https://travis-ci.org/Simon Wicha/NDParallaxIntroView)
[![Version](https://img.shields.io/cocoapods/v/NDParallaxIntroView.svg?style=flat)](http://cocoadocs.org/docsets/NDParallaxIntroView)
[![License](https://img.shields.io/cocoapods/l/NDParallaxIntroView.svg?style=flat)](http://cocoadocs.org/docsets/NDParallaxIntroView)
[![Platform](https://img.shields.io/cocoapods/p/NDParallaxIntroView.svg?style=flat)](http://cocoadocs.org/docsets/NDParallaxIntroView)

## Installation

Just copy the NDParallaxIntroView folder into your project. A cocoapod is planned and will be available soon.

## Usage

Create a strong property of NDParallaxIntroView in your class from which you want to trigger your intro.

Add delegate to protocol into your .h
``` objective-c
#import "NDParallaxIntroView.h"

@interface ViewController : UIViewController <NDParallaxIntroViewDelegate>
```
Usage:
``` objective-c
self.introView = [[NDIntroView alloc] initWithFrame:self.view.frame parallaxImage:[UIImage imageNamed:@"parallaxBgImage"] andData:pageContentArray];
self.introView.delegate = self;
[self.view addSubview:self.introView];
```
Important - You need to create the pageContentArray first which follows an easy structure (see example below):
``` objective-c
NSArray *pageContentArray = @[@{kNDIntroPageTitle : @"Work-It-Out",
kNDIntroPageDescription : @"A great App to create your own personal workout and get instructed by your phone.",
kNDIntroPageImageName : @"workitout"
},
@{kNDIntroPageTitle : @"ColorSkill",
kNDIntroPageDescription : @"A small game while waiting for the bus. Easy, quick and addictive.",
kNDIntroPageImageName : @"colorskill"
},
@{kNDIntroPageTitle : @"Appreciate",
kNDIntroPageDescription : @"A little helper to make your life happier. Soon available on the AppStore",
kNDIntroPageImageName : @"appreciate"
},
@{kNDIntroPageTitle : @"Do you like it?",
kNDIntroPageImageName : @"firstImage",
kNDIntroPageTitleLabelHeightConstraintValue : @0,
kNDIntroPageImageHorizontalConstraintValue : @-40
}
];
```
Delegate method implementation is required
``` objective-c
-(void)launchAppButtonPressed
```

## Screenshot

Animated gif of NDParallaxIntroView

![](https://github.com/s1m-0n/NDCollapsiveDatePicker/blob/master/demo1.gif "NDCollapsiveDateView")

## Author

Simon Wicha | simon.wicha@nomis-development.net

## License

NDParallaxIntroView is available under the MIT license. See the LICENSE file for more info.

0 comments on commit 316882d

Please sign in to comment.