Permalink
Browse files

Added license and readme

  • Loading branch information...
1 parent 9db3c2e commit c8fedc1a3dfb18e7ee9ea8993d2a1b2e15106964 @nihalahmed committed Mar 17, 2012
Showing with 74 additions and 0 deletions.
  1. +10 −0 LICENSE
  2. +64 −0 README.md
View
10 LICENSE
@@ -0,0 +1,10 @@
+Copyright (c) 2012, Nihal Ahmed
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Neither the name of NABZ Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -0,0 +1,64 @@
+NotificationManager
+=========================
+
+NotificationManager is a stand-alone class that can be used to display notifications to the user similar to the Game Center notifications, but with more features.
+
+Features
+--------
+
+-Adjusts to any device orientation
+-Customizable duration and several other parameters
+-Supports custom icon
+-Multi-line text
+-2 different styles: Slide-In and Fade-In
+-Works on iPhone and iPad with iOS 3.2 onwards
+
+Installation
+____________
+
+Add the `QuartzCore` Framework to your Xcode project
+
+Add the following files to your Xcode project (make sure to select Copy Items in the dialog):
+
+-NotificationManager.h
+-NotificationManager.m
+
+Import the `NotificationManager.h`
+
+Usage
+_____
+
+Display a text-only notification:
+
+<pre>
+ [[NotificationManager defaultManager] notifyText:@"This is a notification." withStyle:NotificationStyleSlideIn];
+</pre>
+
+Display a notification with specified icon:
+
+<pre>
+ [[NotificationManager defaultManager] notifyText:@"This is a notification with an icon." withIcon:@"icon_info.png" withStyle:NotificationStyleSlideIn];
+</pre>
+
+Display notification using Fade-In style:
+
+<pre>
+ [[NotificationManager defaultManager] notifyText:@"This is a fade-in notification." withStyle:NotificationStyleFadeIn];
+</pre>
+
+Display notification with custom duration:
+
+<pre>
+ [[NotificationManager defaultManager] notifyText:@"This notification is taking too long." withStyle:NotificationStyleFadeIn forDuration:5];
+</pre>
+
+Separate your text with `/n` to use multi-line notifications:
+
+<pre>
+ [[NotificationManager defaultManager] notifyText:@"This is the first line./nThis is the second line" withStyle:NotificationStyleSlideIn];
+</pre>
+
+Customization
+-------------
+
+To customize the look of the notifications, open the `-NotificationManager.h` file and change the defined constants to alter the font, size and colors.

0 comments on commit c8fedc1

Please sign in to comment.