Skip to content
This repository was archived by the owner on Jul 1, 2022. It is now read-only.

davidrothera/RumbleStrip

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RumbleStrip

CI Status Version License Platform

RumbleStrip is a lightweight feedback tool which allows your users to 'Rage Shake' to give feedback.

Example

Usage (Objective-C)

Once you have the pod installed, usage is very simple:

  1. Import RumbleStrip in your AppDelegate

    #import <RumbleStrip/RumbleStrip.h>
  2. Enable RumbleStrip

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        [RumbleStrip enableRumble];
        // or
        RumbleStrip *feedback = [RumbleStrip enableRumble];
        [feedback setSubject:@"Test Subject"];
        [feedback setRecipients:@[ @"test@email.com" ];
    
        return YES;
    }

Once you have RumbleStrip installed and enabled you can "shake" to device to initiate RumbleStrip.

At present it will show a dialog to the user asking if they would like to provide feedback, if they say yes they will be directed to an e-mail template with a screenshot and other diagnostic information attached.

Usage (Swift)

Once installed (either manually or with CocoaPods) using RumbleStrip is nice and easy:

  1. Import RumbleStrip where you intend to initiate it (usually where your App Delegate function is)

    import RumbleStrip
  2. Enable RumbleStrip

    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject : AnyObject]?) -> Bool {
        // Enable RumbleStripe
        let rumble = RumbleStrip.enableRumble()
        rumble.recipients = ["help@yourapp.com"]
        rumble.subject = "Feedback for your app"
        // or
        RumbleStrip.enableRumble()
    }

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

RumbleStrip doesn't have many requirements other than a couple of Apple provided libraries.

  • iOS8 or higher - this is to support Frameworks (for Swift)
  • MessageUI framework
  • Audiotoolbox framework

Installation

RumbleStrip is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "RumbleStrip"

Author

David Rothera, david.rothera@gmail.com

License

RumbleStrip is available under the MIT license. See the LICENSE file for more info.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors