Skip to content

Commit 5c08a1b

Browse files
zengxinzhyzengxinzhy
committed
2 parents 5babcca + 91a0b83 commit 5c08a1b

File tree

2 files changed

+146
-10
lines changed

2 files changed

+146
-10
lines changed

‎README.md‎

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,65 @@
11
# TinyCrayon SDK for iOS
2+
> A smart and easy-to-use image masking and cutout SDK for mobile apps.
3+
4+
[![Website](https://img.shields.io/website/http/tinycrayon.com/.svg)](http://www.tinycrayon.com/)
5+
[![platform](https://img.shields.io/cocoapods/p/TinyCrayon.svg)](https://cocoapods.org/pods/TinyCrayon)
6+
[![Compatible](https://img.shields.io/badge/compatible-Swift%20%2F%20Objective--C%20-yellow.svg)](https://cocoapods.org/pods/TinyCrayon)
7+
[![CocoaPods](https://img.shields.io/cocoapods/v/TinyCrayon.svg)](https://cocoapods.org/pods/TinyCrayon)
8+
[![Documentation](https://img.shields.io/badge/docs-latest-green.svg)](https://www.tinycrayon.com/docs-iOS/index.html)
9+
[![App Store](https://img.shields.io/badge/app%20store-sample%20apps-orange.svg)](https://itunes.apple.com/developer/yongyun-zeng/id1071044410)
10+
[![license](https://img.shields.io/cocoapods/l/TinyCrayon.svg)](https://github.com/TinyCrayon/TinyCrayon-iOS-SDK/blob/master/LICENSE)
11+
12+
TinyCrayon SDK provides tools for adding image cutout and layer mask capabilities to your mobile applications.
13+
14+
![Quick Select Tool](https://cloud.githubusercontent.com/assets/4088232/23604872/7248944e-0295-11e7-83dc-002b267789d1.gif) | ![Hair Brush Tool](https://cloud.githubusercontent.com/assets/4088232/23604871/6f0c390c-0295-11e7-979d-f4824d839931.gif)
15+
------------ | -------------
16+
Quick Select Tool | Hair Brush Tool
17+
18+
Try our sample apps [Image Eraser](https://itunes.apple.com/app/id1072712460), [Color Effect](https://itunes.apple.com/app/id1222383759), [Focus Effect](https://itunes.apple.com/app/id1064333794).
19+
20+
## Table of Contents
21+
22+
* [Overview](#overview)
23+
* [Features](#features)
24+
* [Installation](#installation)
25+
* [Prerequisites](#prerequisites)
26+
* [Streamlined, using CocoaPods](#streamlined-using-cocoapods)
27+
* [Manually, using the SDK download](#manually-using-the-sdk-download)
28+
* [Download the SDK](#download-the-sdk)
29+
* [Add the framework](#add-the-framework)
30+
* [Settings for Objective-C](#settings-for-objective-c)
31+
* [Usage](#usage)
32+
* [Add a TCMaskView](#add-a-tcmaskview)
33+
* [TCMask class](#tcmask-class)
34+
* [Further reading](#further-reading)
35+
* [License](#license)
36+
* [Terms of use](#terms-of-use)
237

338
## Overview
4-
TinyCrayon SDK provides tools for adding image layer mask capabilities to your mobile applications.
39+
TinyCrayon SDK provides tools for adding image cutout and layer mask capabilities to your mobile applications.
540

641
Image layer mask is a fundamental technique in image manipulations. It allows you to selectively modify the opacity (transparency) of the layer they belong to. This flexibility to define the opacity of different areas of a layer is the basis for more interesting image manipulation techniques such as selective coloring and luminosity masking.
742

843
The current version of TinyCrayon SDK provides the following three tools:
9-
* Quick Select: Smart and easy to use, you just need to select part of the object and the edge detection algorithm will find the boundary for you.
44+
* Quick Select: Smart and easy to use, users just need to select part of the object and the edge detection algorithm will find the boundary.
1045
* Hair Brush: Smooth and natual looking, paint on the hair/fur of an object and the algorithm will select the hair/fur for you in high quality.
1146
* Regular Brush: A regular brush tool with the capability to adjust its size, hardness and opacity.
1247

13-
![Quick Select Tool](https://cloud.githubusercontent.com/assets/4088232/23604872/7248944e-0295-11e7-83dc-002b267789d1.gif) | ![Hair Brush Tool](https://cloud.githubusercontent.com/assets/4088232/23604871/6f0c390c-0295-11e7-979d-f4824d839931.gif)
14-
------------ | -------------
15-
Quick Select Tool | Hair Brush Tool
16-
1748
## Features
1849
* Free: TinyCrayon SDK is provided under MIT license, you can use it in your commercial applications for free!
1950
* iPad support: TinyCrayon SDK uses auto layout for its views and adapts to each screen size - iPhone or iPad.
20-
* Highly customizable: Style the UI and view modes as you wish.
51+
* Highly customizable: Style the UI, view modes and localized languages as you wish.
2152
* Swift: Keeping up with time, we chose Swift as the main development language of the TinyCrayon SDK, leading to leaner easier code.
2253
* Objective-C support: All of our public API is Objective-C compatible.
2354

55+
![create as many effects as you can think of](https://cloud.githubusercontent.com/assets/4088232/24956166/ffc4285c-1fb8-11e7-9743-209de801e31a.jpg)
56+
2457
## Installation
2558

2659
### Prerequisites
2760
* Xcode 8.0 or later.
2861
* A physical iOS device.
29-
* Recommended: [installation of CocoaPods](http://guides.cocoapods.org/using/getting-started) to simplify dependency management
62+
* Recommended: [installation of CocoaPods](http://guides.cocoapods.org/using/getting-started) to simplify dependency management.
3063

3164
### Streamlined, using CocoaPods
3265
TinyCrayon SDK is available via CocoaPods. If you're new to CocoaPods, this [Getting Started Guide](https://guides.cocoapods.org/using/getting-started.html) will help you. CocoaPods is the preferred and simplest way to use the TinyCrayon SDK.
@@ -50,7 +83,7 @@ If you don't want to use Cocoapods you can still take advantage of the TinyCrayo
5083

5184
#### Download the SDK
5285

53-
1. Download the [TinyCrayon SDK zip](https://www.tinycrayon.com/sdk/iOS/TinyCrayon_v1.0.2.zip) (this is a ~6MB file and may take some time).
86+
1. Download the [TinyCrayon SDK zip](https://www.tinycrayon.com/sdk/iOS/TinyCrayon.zip) (this is a ~20MB file and may take some time).
5487
2. Unzip the TinyCrayon.zip
5588

5689
#### Add the framework
@@ -118,8 +151,11 @@ UIImage *outputImage = [mask cutoutWithImage:image resize:false];
118151
To try these examples, and find out about more options please take a look at the [Examples](https://github.com/TinyCrayon/TinyCrayon-iOS-SDK/releases).
119152

120153
## Further reading
121-
* Try our sample app [Image Eraser](https://itunes.apple.com/app/id1072712460).
154+
* Try our sample apps [Image Eraser](https://itunes.apple.com/app/id1072712460), [Color Effect](https://itunes.apple.com/app/id1222383759), [Focus Effect](https://itunes.apple.com/app/id1064333794).
122155
* Check out TinyCrayon [guides](http://tinycrayon.com/guides-iOS/get-started.html) and [API reference](http://tinycrayon.com/docs-iOS/index.html) for more details.
123156

124157
## License
125158
The MIT license
159+
160+
## Terms of use
161+
By using TinyCrayon SDK, you agree to keep the banner ad embedded in TCMaskView fully viewable and clickable to the users.

‎helloworld.swift‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
print("Hello World!")
2+
print("Welcome to TinyCrayon iOS SDK!")
3+
print("Welcome to TinyCrayon iOS SDK!")
4+
print("Welcome to TinyCrayon iOS SDK!")
5+
print("Welcome to TinyCrayon iOS SDK!")
6+
print("Welcome to TinyCrayon iOS SDK!")
7+
print("Welcome to TinyCrayon iOS SDK!")
8+
print("Welcome to TinyCrayon iOS SDK!")
9+
print("Welcome to TinyCrayon iOS SDK!")
10+
print("Welcome to TinyCrayon iOS SDK!")
11+
print("Welcome to TinyCrayon iOS SDK!")
12+
print("Welcome to TinyCrayon iOS SDK!")
13+
print("Welcome to TinyCrayon iOS SDK!")
14+
print("Welcome to TinyCrayon iOS SDK!")
15+
print("Welcome to TinyCrayon iOS SDK!")
16+
print("Welcome to TinyCrayon iOS SDK!")
17+
print("Welcome to TinyCrayon iOS SDK!")
18+
print("Welcome to TinyCrayon iOS SDK!")
19+
print("Welcome to TinyCrayon iOS SDK!")
20+
print("Welcome to TinyCrayon iOS SDK!")
21+
print("Welcome to TinyCrayon iOS SDK!")
22+
print("Welcome to TinyCrayon iOS SDK!")
23+
print("Welcome to TinyCrayon iOS SDK!")
24+
print("Welcome to TinyCrayon iOS SDK!")
25+
print("Welcome to TinyCrayon iOS SDK!")
26+
print("Welcome to TinyCrayon iOS SDK!")
27+
print("Welcome to TinyCrayon iOS SDK!")
28+
print("Welcome to TinyCrayon iOS SDK!")
29+
print("Welcome to TinyCrayon iOS SDK!")
30+
print("Welcome to TinyCrayon iOS SDK!")
31+
print("Welcome to TinyCrayon iOS SDK!")
32+
print("Welcome to TinyCrayon iOS SDK!")
33+
print("Welcome to TinyCrayon iOS SDK!")
34+
print("Welcome to TinyCrayon iOS SDK!")
35+
print("Welcome to TinyCrayon iOS SDK!")
36+
print("Welcome to TinyCrayon iOS SDK!")
37+
print("Welcome to TinyCrayon iOS SDK!")
38+
print("Welcome to TinyCrayon iOS SDK!")
39+
print("Welcome to TinyCrayon iOS SDK!")
40+
print("Welcome to TinyCrayon iOS SDK!")
41+
print("Welcome to TinyCrayon iOS SDK!")
42+
print("Welcome to TinyCrayon iOS SDK!")
43+
print("Welcome to TinyCrayon iOS SDK!")
44+
print("Welcome to TinyCrayon iOS SDK!")
45+
print("Welcome to TinyCrayon iOS SDK!")
46+
print("Welcome to TinyCrayon iOS SDK!")
47+
print("Welcome to TinyCrayon iOS SDK!")
48+
print("Welcome to TinyCrayon iOS SDK!")
49+
print("Welcome to TinyCrayon iOS SDK!")
50+
print("Welcome to TinyCrayon iOS SDK!")
51+
print("Welcome to TinyCrayon iOS SDK!")
52+
print("Welcome to TinyCrayon iOS SDK!")
53+
print("Welcome to TinyCrayon iOS SDK!")
54+
print("Welcome to TinyCrayon iOS SDK!")
55+
print("Welcome to TinyCrayon iOS SDK!")
56+
print("Welcome to TinyCrayon iOS SDK!")
57+
print("Welcome to TinyCrayon iOS SDK!")
58+
print("Welcome to TinyCrayon iOS SDK!")
59+
print("Welcome to TinyCrayon iOS SDK!")
60+
print("Welcome to TinyCrayon iOS SDK!")
61+
print("Welcome to TinyCrayon iOS SDK!")
62+
print("Welcome to TinyCrayon iOS SDK!")
63+
print("Welcome to TinyCrayon iOS SDK!")
64+
print("Welcome to TinyCrayon iOS SDK!")
65+
print("Welcome to TinyCrayon iOS SDK!")
66+
print("Welcome to TinyCrayon iOS SDK!")
67+
print("Welcome to TinyCrayon iOS SDK!")
68+
print("Welcome to TinyCrayon iOS SDK!")
69+
print("Welcome to TinyCrayon iOS SDK!")
70+
print("Welcome to TinyCrayon iOS SDK!")
71+
print("Welcome to TinyCrayon iOS SDK!")
72+
print("Welcome to TinyCrayon iOS SDK!")
73+
print("Welcome to TinyCrayon iOS SDK!")
74+
print("Welcome to TinyCrayon iOS SDK!")
75+
print("Welcome to TinyCrayon iOS SDK!")
76+
print("Welcome to TinyCrayon iOS SDK!")
77+
print("Welcome to TinyCrayon iOS SDK!")
78+
print("Welcome to TinyCrayon iOS SDK!")
79+
print("Welcome to TinyCrayon iOS SDK!")
80+
print("Welcome to TinyCrayon iOS SDK!")
81+
print("Welcome to TinyCrayon iOS SDK!")
82+
print("Welcome to TinyCrayon iOS SDK!")
83+
print("Welcome to TinyCrayon iOS SDK!")
84+
print("Welcome to TinyCrayon iOS SDK!")
85+
print("Welcome to TinyCrayon iOS SDK!")
86+
print("Welcome to TinyCrayon iOS SDK!")
87+
print("Welcome to TinyCrayon iOS SDK!")
88+
print("Welcome to TinyCrayon iOS SDK!")
89+
print("Welcome to TinyCrayon iOS SDK!")
90+
print("Welcome to TinyCrayon iOS SDK!")
91+
print("Welcome to TinyCrayon iOS SDK!")
92+
print("Welcome to TinyCrayon iOS SDK!")
93+
print("Welcome to TinyCrayon iOS SDK!")
94+
print("Welcome to TinyCrayon iOS SDK!")
95+
print("Welcome to TinyCrayon iOS SDK!")
96+
print("Welcome to TinyCrayon iOS SDK!")
97+
print("Welcome to TinyCrayon iOS SDK!")
98+
print("Welcome to TinyCrayon iOS SDK!")
99+
print("Welcome to TinyCrayon iOS SDK!")
100+
print("Welcome to TinyCrayon iOS SDK!")

0 commit comments

Comments
 (0)