Permalink
Browse files

Update Readme.md with dynamic configuration

  • Loading branch information...
1 parent da20fe6 commit 7b34e4ca9959281e1374a63688551b65a0024e1f @hpique hpique committed Aug 31, 2012
Showing with 20 additions and 7 deletions.
  1. +20 −7 README.md
View
27 README.md
@@ -8,12 +8,24 @@ homepage] [homepage].
Getting Started
---------------
-1. Add the Appirater code into your project
-2. Add the `CFNetwork` and `SystemConfiguration` frameworks to your project
-3. Call `[Appirater appLaunched:YES]` at the end of your app delegate's `application:didFinishLaunchingWithOptions:` method.
-4. Call `[Appirater appEnteredForeground:YES]` in your app delegate's `applicationWillEnterForeground:` method.
-5. (OPTIONAL) Call `[Appirater userDidSignificantEvent:YES]` when the user does something 'significant' in the app.
-6. Finally, call `[Appirater setAppId:@"yourAppId"]` with your Apple provided software id.
+1. Add the Appirater code into your project.
+2. Add the `CFNetwork` and `SystemConfiguration` frameworks to your project.
+3. Call `[Appirater setAppId:@"yourAppId"]` with the app id provided by Apple. A good place to do this is at the beginning of your app delegate's `application:didFinishLaunchingWithOptions:` method.
+4. Call `[Appirater appLaunched:YES]` at the end of your app delegate's `application:didFinishLaunchingWithOptions:` method.
+5. Call `[Appirater appEnteredForeground:YES]` in your app delegate's `applicationWillEnterForeground:` method.
+6. (OPTIONAL) Call `[Appirater userDidSignificantEvent:YES]` when the user does something 'significant' in the app.
+
+Configuration
+-------------
+
+Appirater provides class methods to configure its behavior. See [`Appirater.h`] [Appirater.h] for more information.
+
+ [Appirater setAppId:@"552035781"];
+ [Appirater setDaysUntilPrompt:1];
+ [Appirater setUsesUntilPrompt:10];
+ [Appirater setSignificantEventsUntilPrompt:-1];
+ [Appirater setTimeBeforeReminding:2];
+ [Appirater setDebug:YES];
License
-------
@@ -30,4 +42,5 @@ MonoTouch Port
[homepage]: http://arashpayan.com/blog/index.php/2009/09/07/presenting-appirater/
[arash]: http://arashpayan.com
[ivan]: https://www.facebook.com/nikitinivan
-[monotouchport]: https://github.com/chebum/Appirater-for-MonoTouch
+[monotouchport]: https://github.com/chebum/Appirater-for-MonoTouch
+[Appirater.h]: https://github.com/arashpayan/appirater/blob/master/Appirater.h

0 comments on commit 7b34e4c

Please sign in to comment.