mirror of
https://github.com/zhigang1992/KLCircleViewController.git
synced 2026-04-29 20:46:15 +08:00
Updated Documentation
This commit is contained in:
62
README.md
Normal file
62
README.md
Normal file
@@ -0,0 +1,62 @@
|
||||
<img src="https://raw.github.com/KieranLafferty/KLCircleViewController/master/KLCircleViewControllerDemo/Demo.gif" width="50%"/>
|
||||
|
||||
KLCircleViewController
|
||||
=======
|
||||
|
||||
A control that allows panning between view controllers as inspired by the Circle app.
|
||||
|
||||
Note: KLCircleViewController is intended for use with portrait orientation on iPhone/iPod Touch.
|
||||
|
||||
Requires ARC
|
||||
|
||||
*Source is dual licensed. Can be used freely without restriction on FREE apps, PAID apps require a license purchased from https://www.cocoacontrols.com/controls/KLCircleViewController*
|
||||
|
||||
[Check out the Demo](http://www.youtube.com/watch?v=uorJfwpTzoI) *Excuse the graphics glitches and lag due to my slow computer.*
|
||||
|
||||
|
||||
## Installation ##
|
||||
|
||||
1. Drag the KLCircleViewController.xcodeproj to your existing project
|
||||
2. Under Build Phases on your project's Xcode Project file add 'KLCircleViewController(KLCircleViewController)' to your Target Dependancies
|
||||
3. Under Build on your Xcode Project file add 'libKLCircleViewController' & QuartzCore.framework under Link Binary With Libraries
|
||||
4. Include #import <KLCircleViewController/KLCircleViewController.h> in any file you wish to use
|
||||
|
||||
|
||||
## Usage ##
|
||||
|
||||
Import the header file and declare your controller to subclass KLScrollViewController
|
||||
|
||||
#import <KLCircleViewController/KLCircleViewController.h>
|
||||
...
|
||||
[[KLCircleViewController alloc] initWithCenterViewController: center
|
||||
leftViewController: left
|
||||
rightViewController: right
|
||||
bottomViewController: bottom];
|
||||
|
||||
OR, Import the header file and declare your controller to conform to KLCircleViewControllerDelegate and KLCircleViewControllerDataSrouce
|
||||
|
||||
#import <KLCircleViewController/KLCircleViewController.h>
|
||||
@interface KLViewController : UIViewController <KLCircleViewControllerDataSource, KLCircleViewControllerDelegate>
|
||||
|
||||
|
||||
## Contact ##
|
||||
|
||||
* [@kieran_lafferty](https://twitter.com/kieran_lafferty) on Twitter
|
||||
* [@kieranlafferty](https://github.com/kieranlafferty) on Github
|
||||
* <a href="mailTo:kieran.lafferty@gmail.com">kieran.lafferty [at] gmail [dot] com</a>
|
||||
|
||||
## License ##
|
||||
|
||||
Copyright 2013 Kieran Lafferty
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
Reference in New Issue
Block a user