From 59fcdd4f57b88c00857be56bd38f48459432fb36 Mon Sep 17 00:00:00 2001 From: Warren Moore Date: Mon, 17 Sep 2012 02:13:21 -0500 Subject: [PATCH] Wrote basic README file --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index e69de29..301c71d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,27 @@ +# AHAlertView + +## Overview + +`AHAlertView` is a powerful, block-based alternative to UIKit's `UIAlertView`. It has the following attractive features: + + 1. Block-based button events - no more messy delegate code + 2. `UIAppearance` conformance to allow easy skinning of all elements + 3. Additional presentation and dismissal animations (tumble, fade, zoom, etc.) + +Showing an alert is as simple as creating an alert, adding a button, and showing the alert: + + AHAlertView *alert = [[AHAlertView alloc] initWithTitle:@"Hello, World!" message:@"I'm an alert view!"]; + [alert setCancelButtonTitle:@"Dismiss" block:nil]; + [alert show]; + +You can use the block you pass in with the button title to perform any action, including setting a custom dismissal animation based on which button was touched: + + [alert setCancelButtonTitle:@"Cancel" block:^{ + alert.dismissalStyle = AHAlertViewDismissalStyleTumble; + }]; + +## TODO + + - Currently, only the default style (title and message) is available. Styles with text fields or an activity indicator are planned. + - The layout code is monolithic and inflexible. It needs to be cleaned up. + - I think we can all agree a little more documentation would be nice. \ No newline at end of file