<commit_before>Tattle-UI-iOS
=============

Tattle UI control library for IOS<commit_msg>Initial md file<commit_after>### Tattle-UI-iOS
-----------------

## Why do you need Tattle-UI

As a developer, we struggle to understand and reproduce few UI
bugs reported by the beta-tester. In tester's point of view, tester
writes paragraphs to explain a simple UI misalignment when they test.

Tattle-UI solves this problem by providing simpler mechanism to get UI feedback
from beta-testers. 

## What do you see on your app

After integration, Tattle library adds a floating button on every screen. 
Tester can click on this button whenever he sees some issue with the UI.
Tattle library takes the snapshot of the current screen and allow the tester
to mark problematic section using scribbles. Tester may wish to add a audio note along with this. 
Tattle provides tester to send them in Email. 

## Integration steps

In two ways you can get Tattle-UI
1) From github 
   a) Download the code from github and include the files into your project. 
   b) Include following frameworks
        - OpenGLES.framework
        - QuartzCore.framework
        - AVFoundation.framework
        - CoreGraphics.framework
        - MessageUI.framework
        - ImageIO.framework  
2) From cocoapod
   a) Add pod 'TattleUI' to your Podfile and run pod install

## Usage
1. Import "UIController+SnapShotButton.h" file into App-Prefix.pch file 

```
import "UIController+SnapShotButton.h"
```

2. Enable Tattle control by adding following line in "AppDelegate.m"

```
#import "ScreenShotControl.h"
```

3. Invoke 'enableTattleToWindow:' method, after main window creation.

```
self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]]; 
[[TattleControl sharedControl] enableTattleToWindow:self.window];
```

## Configuration


# Change scribble color (default black)

```
[[TattleControl sharedControl] setScribbleColor:YOUR_Color];
```

# Change background color of movable control(floating button) default is black(transparent)

```
[[TattleControl sharedControl] setMovableControlBackgroundColor:YOUR_Color];
[[TattleControl sharedControl] setMovableControlBackgroundColor:YOUR_Color withAlpha:alpha];
```

# Set recipients email 
```
[[TattleControl sharedControl] assignRecipientEmailId:@"YOUR_EMAIL_HERE" withCCId:@"YOUR_EMAIL_HERE" emailSubject:@"UI Bug using Tattle UI"];
```

# Add more Recipient

```
[[TattleControl sharedControl] addRecipientMailId:@"YOUR_EMAIL_HERE"];
```

# Add more CC

```
[[TattleControl sharedControl] addCCMailId:@"YOUR_EMAIL_HERE"];
```

# Tested OS version

Tattle UI has been tested in iPhone 6+ and iPad 


{'fraction_non_alphanumeric': 0.09410430839002268, 'fraction_numerical': 0.0022675736961451248, 'mean_word_length': 4.560924369747899, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4450420', 'n_tokens_mistral': 814, 'n_tokens_neox': 746, 'n_words': 283}