ratekit's Introduction

RateKit

RateKit is an easy way for developers to request ratings and reviews in Mac App Store.

中文版

Installation

Clone the rep, build the RateKit or copy all the source files into your project.

Features

Customization and Configuration to your needs
Awesome UI to request users to rate app in Mac App Store
Display rate window with animations

Example

To run the example project, clone the repo, build and run the target 'RateKitDemo'.

Getting started

Create rate window configuration


    RateConfigure *configure = [[RateConfigure alloc] init];
    [configure setName:@"Love Ratekit?"];
    [configure setIcon:[NSImage imageNamed:@"demo-icon"]];
    [configure setDetailText:@"We look forward to your Star and Pull Request to make Ratekit better and better : )\n⭐️⭐️⭐️⭐️⭐️"];
    [configure setLikeButtonTitle:@"Star Now!"];
    [configure setIgnoreButtonTitle:@"Maybe later"];
    [configure setRateURL:[NSURL URLWithString:@"https://github.com/HsiangHo/RateKit"]];

Make a rate window and request users to rate app.

    RateWindowController *rateWindowController = [[RateWindowController alloc] initWithConfigure:configure];
    //Set a timeout for rate window to close itself automatically.
    [rateWindowController setRateTimeout:10];
    //Request rate window
    [rateWindowController requestRateWindow:RateWindowPositionTopRight withRateCompletionCallback:^(RateResult rlst) {
        switch (rlst) {
            case RateResultRated:
                // User clicked 'Rate' button
                break;
                
            case RateResultLater:
                // User clicked 'Later' button
                break;
                
            case RateResultTimeout:
                // User did nothing
                break;
                
            default:
                break;
        }
    }];