This repository has been archived by the owner on Oct 4, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5938da1
commit 8b78f33
Showing
1 changed file
with
3 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,19 +2,19 @@ | |
<img src="http://i.imgur.com/fkR8t4g.png" alt="BARK" title="BARK"> | ||
</p> | ||
|
||
BARK (Better App Reporting Kit) is a simple, in-app issue reporting library for iOS. Shaking the app pulls up an action sheet, where beta users can instantly send email or create GitHub issues. | ||
BARK (Better App Reporting Kit) is a simple, in-app issue reporting library for iOS. Shaking the app pulls up an action sheet, where beta users can instantly send email or create GitHub issues - with screenshots automatically attached. | ||
|
||
<p align="center"> | ||
<img src="http://i.imgur.com/Tge4KbW.png" alt="action sheet" title="action sheet" width="300" height="564"> | ||
<img src="http://i.imgur.com/iu0iydA.png" alt="issue view" title="issue view" width="300" height="564"> | ||
<img src="http://i.imgur.com/DBLeoeY.png" alt="issue view" title="issue view" width="300" height="564"> | ||
</p> | ||
## Get Started ## | ||
|
||
1. Add BARK to your Podfile `pod 'Bark', '~> 0.2'` or clone the repository with `git clone [email protected]:stagebloc/bark.git` | ||
2. Link the following frameworks in the Build Phases tab: | ||
- `MessageUI` - to send emails from within the app | ||
- `SystemConfiguration` - for network reachability support | ||
- `Security` - for secure storage of GitHub credentials. | ||
- `Security` - for secure storage of GitHub credentials | ||
- `MobileCoreServices` - for file MIME type detection on uploaded images | ||
4. In your `AppDelegate.h` file, `#import "SBBark.h"`, and add `<SBBarkDelegate>` to the delegate list. | ||
5. Set `self.window` equal to the SBWindow subclass, as shown below - make sure to set `bark.repositoryName` to the name of the repository you want to submit issues to. | ||
|
@@ -87,10 +87,6 @@ BARK can also be shown programmatically anywhere in the application using the `S | |
[[SBBark sharedBark] showBark]; | ||
``` | ||
|
||
### Coming Soon ### | ||
|
||
Submitting images through the GitHub API is currently unsupported. We're planning to build a workaround to make this possible, so you'll soon be able to attach screenshots to GitHub issues as well. | ||
|
||
## Using BARK in Production ## | ||
|
||
BARK can be used in production by customizing the `shouldShowActionSheet` method. You'll need to create your own way of determining whether or not the current user is an admin. Take a look at the example below - we check against the logged in user's email address. | ||
|