Permalink
Browse files

Update Readme.

  • Loading branch information...
1 parent 14de229 commit a5e2718c479a7afccb3cb44fd425b593540d0d46 Rafał Sroka committed Feb 16, 2014
Showing with 17 additions and 2 deletions.
  1. +17 −2 README.mdown
View
@@ -8,10 +8,25 @@ This can be useful in UIImageView animations where animationImages array has to
-(NSArray *)spritesWithSpriteSheetImage:(UIImage *)image spriteSize:(CGSize)size;
-(NSArray *)spritesWithSpriteSheetImage:(UIImage *)image inRange:(NSRange)range spriteSize:(CGSize)size;
+Quick start
+=======
+
+Just copy `UIImage+SpriteAdditions.h` and `UIImage+SpriteAdditions.m` to your project or use CocoaPods to install the pod.
+
+Instructions for CocoaPods users:
+
+1. Install [CocoaPods](http://cocoapods.org/) with `gem install cocoapods`.
+2. Create a file in your XCode project called `Podfile` and add the following line:
+
+ pod 'UIImage+SpriteAdditions'
+
+3. Run `pod install` in your xcode project directory. CocoaPods should download and
+install the UIImage+SpriteAdditions category, and create a new Xcode workspace. Open up this workspace in Xcode.
+
How to
=======
-There are two methods in UIImage+Sprite category. First one:
+There are two methods in UIImage+SpriteAdditions category. First one:
-(NSArray *)spritesWithSpriteSheetImage:(UIImage *)image spriteSize:(CGSize)size;
@@ -45,4 +60,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
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.
+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.

0 comments on commit a5e2718

Please sign in to comment.