Skip to content

Commit

Permalink
Converted README to Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Szymanski authored and Arash Payan committed Aug 25, 2010
1 parent cdfba2f commit 219a344
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Introduction
------------
Appirater is a class that you can drop into any iPhone app that will help remind your users
to review your app on the App Store. The code is released under the MIT/X11, so feel free to
modify and share your changes with the world. To find out more, check out the [project
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]` at the end of your app delegate's `application:didFinishLaunchingWithOptions:` method.
4) Finally, set the `APPIRATER_APP_ID` in `Appirater.h` to your Apple provided software id.

License
-------
Copyright 2008. [Arash Payan] [arash].
This library is distributed under the terms of the MIT/X11.

While not required, I greatly encourage and appreciate any improvements that you make
to this library be contributed back for the benefit of all who use Appirater.

[homepage]: http://arashpayan.com/blog/index.php/2009/09/07/presenting-appirater/
[arash]: http://arashpayan.com

0 comments on commit 219a344

Please sign in to comment.