<commit_before># GitYourFeedack

[![CI Status](http://img.shields.io/travis/<NAME>/GitYourFeedack.svg?style=flat)](https://travis-ci.org/<NAME>/GitYourFeedack)
[![Version](https://img.shields.io/cocoapods/v/GitYourFeedack.svg?style=flat)](http://cocoapods.org/pods/GitYourFeedack)
[![License](https://img.shields.io/cocoapods/l/GitYourFeedack.svg?style=flat)](http://cocoapods.org/pods/GitYourFeedack)
[![Platform](https://img.shields.io/cocoapods/p/GitYourFeedack.svg?style=flat)](http://cocoapods.org/pods/GitYourFeedack)

## Example

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

## Requirements
* Google Cloud Storage bucket for storing the screenshots.
* Github repository for storing the issues.

## Installation

GitYourFeedack is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:

```ruby
pod "GitYourFeedack"
```

1. Generate a [Personal Access Token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) for the Github user who will be saving the issues in your repo.

2. In your project's `Info.plist` add a key of `NSPhotoLibraryUsageDescription` with a string explaining that your use of the photo library is for submitting screenshots.

3. In your AppDelegate, or some other long-lived controller:

```
let feedback = FeedbackManager(githubApiToken: "<PASSWORD>", repo: "gabek/GKBugreportertest", googleStorageBucket: "myapp-storage-bucket.appspot.com", labels: ["Feedback", "Bugs", "Whatever Github Labels You Want"])
```

4. The user feedback interface can be presented in either of these ways:
<commit_msg>Update Readme more as I go along<commit_after># GitYourFeedack

[![Version](https://img.shields.io/cocoapods/v/GitYourFeedack.svg?style=flat)](http://cocoapods.org/pods/GitYourFeedack)
[![License](https://img.shields.io/cocoapods/l/GitYourFeedack.svg?style=flat)](http://cocoapods.org/pods/GitYourFeedack)
[![Platform](https://img.shields.io/cocoapods/p/GitYourFeedack.svg?style=flat)](http://cocoapods.org/pods/GitYourFeedack)

A lot of organizations run on Github, not just for the code repositories, but also for the heavy use of Issues, the bug tracking/feedback reporting tool.  Yet none of the feedback reporting tools use Issues as the datastore.  Instead the expected behavior is to route all of your users to Github and hope they file an issue.

## Example

To run the example project:
* Clone the repo, and run `pod install` from the Example directory.
* Edit `Config.swift` and add your Github API Token, Repository name, and Google Cloud Storage bucket name.

## Requirements
* Google Cloud Storage bucket for storing the screenshots.
* Github repository for storing the issues.

## Installation

GitYourFeedack is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:

```ruby
pod "GitYourFeedack"
```

1. Generate a [Personal Access Token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) for the Github user who will be saving the issues in your repo.

2. In your project's `Info.plist` add a key of `NSPhotoLibraryUsageDescription` with a string explaining that your use of the photo library is for submitting screenshots.

3. In your AppDelegate, or some other long-lived controller:

```
let feedback = FeedbackManager(githubApiToken: "<PASSWORD>", repo: "gabek/GKBugreportertest", googleStorageBucket: "myapp-storage-bucket.appspot.com", labels: ["Feedback", "Bugs", "Whatever Github Labels You Want"])
```

4. The user feedback interface can be presented in either of these ways:

{'fraction_non_alphanumeric': 0.11626637554585152, 'fraction_numerical': 0.002183406113537118, 'mean_word_length': 5.385017421602788, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6825655', 'n_tokens_mistral': 1199, 'n_tokens_neox': 1110, 'n_words': 360}