Permalink
Browse files

- updated README with usage instruction

- added LICENSE
  • Loading branch information...
1 parent 35925aa commit 275eff7f0cc077a95cfb70921c1ca680906219db @honcheng committed Aug 11, 2012
Showing with 84 additions and 5 deletions.
  1. +27 −0 LICENSE
  2. +57 −5 README.md
View
@@ -0,0 +1,27 @@
+Copyright (c) 2012 Muh Hon Cheng
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject
+to the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT
+WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR
+THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+@author Muh Hon Cheng <honcheng@gmail.com>
+@copyright 2012 Muh Hon Cheng
View
@@ -3,18 +3,70 @@ Customizable PageControl for iOS
<img src="https://github.com/honcheng/iOS-StyledPageControl/raw/master/screenshot.png"/>
-StyledPageControl is a replacement for UIPageControl for iOS, but more customizable.
+StyledPageControl is a customizable replacement for UIPageControl for iOS.
-#### Features
+Features
+--------
* 5 Styles
* change colors
* change diameter
* change gap width
* change stroke width
* show current page number
+* use custom images
-#### Minimum Requirements
-XCode 4.4 because it uses auto-synthesis
+Usage
+-----
-[twitter.com/honcheng](http://twitter.com/honcheng)
+1) Drag StyledPageControl.h and StyledPageControl.m into your project.
+
+ #import StyledPageControl.h
+
+2) Create StyledPageControl just like a UIPageControl
+
+ StyledPageControl *pageControl = [[StyledPageControl alloc] init];
+ [self addSubview:pageControl];
+
+3) Set page control style
+
+ [pageControl setPageControlStyle:PageControlStyleDefault];
+
+4) Set number of pages
+
+ [pageControl setNumberOfPages:10];
+
+5) Set current page
+
+ [pageControl setCurrentPage:5];
+
+6) Change page control colors
+
+ [pageControl setCoreNormalColor:[UIColor colorWithRed:0 green:0 blue:0 alpha:1]];
+ [pageControl setCoreSelectedColor:[UIColor colorWithRed:0.8 green:0.2 blue:0.2 alpha:1]];
+
+7) Change distance between dots
+
+ [pageControl setGapWidth:5];
+
+8) Change dot's diameter
+
+ [pageControl setDiameter:9];
+
+9) Use custom thumbnails
+
+ [pageControl setPageControlStyle:PageControlStyleThumb];
+ [pageControl setThumbImage:[UIImage imageNamed:@"pagecontrol-thumb-normal.png"]];
+ [pageControl setSelectedThumbImage:[UIImage imageNamed:@"pagecontrol-thumb-selected.png"]];
+
+
+Minimum Requirements
+--------------------
+* ARC - this project uses ARC. If you are not using ARC in your project, add '-fobjc-arc' as a compiler flag for StyledPageControl.h and StyledPageControl.m
+* XCode 4.4 and newer (auto-synthesis required)
+
+Contact
+-------
+
+[twitter.com/honcheng](http://twitter.com/honcheng)
+[honcheng.com](http://honcheng.com)

0 comments on commit 275eff7

Please sign in to comment.