ihopeit / Butterfly

A lightweight library for integrating feedback module elegantly

Butterfly

Butterfly is a lightweight library for integrating bug-report and feedback features with shake-motion event elegantly.

Just need two lines of code.

This project is inspired by Zhihu v3.0 originally.

Goals of this project

One of the main issues accross the iOS development is the feedback of new features and bug report.

The most common way is to use mailto to send a dry and boring email :

let str = "mailto:[e-mail]?cc=[e-mail]&subject=Greetings%20from%20Cupertino!&body=Wish%20you%20were%20here!"
let url = NSURL(string: str)
UIApplication.sharedApplication().openURL(url)

Butterfly provides an elegant way to present users' feedback as easy as possible.

Quick Look

Installation

via CocoaPod

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'Butterfly', '~> 0.3.0'

Manually

$ git submodule add https://github.com/wongzigii/Butterfly.git

• Open the Butterfly folder, and drag Butterfly.xcodeproj into the file navigator of your app project, under your app project.
• In Xcode, navigate to the target configuration window by clicking on the blue project icon, and selecting the application target under the "Targets" heading in the sidebar.
• In the tab bar at the top of that window, open the "Build Phases" panel.
• Add Kingfisher.framework within the "Target Dependencies"
• Click on the + button at the top left of "Build Phases" panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add Butterfly.framework.

Usage

import Butterfly

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
    ButterflyManager.sharedManager.startListeningShake()
    return true
}

From now on, you can access the screenshot and feedback:

self.screenshot = ButterflyManager.sharedManager.imageWillUpload
self.feedbackText = ButterflyManager.sharedManager.textWillUpload

Contact

• Contact me on Sina Weibo
• Email me
• Issue

License

Butterfly is under MIT LICENCE, see the LICENCE file for more info.