Skip to content

Commit cd4a0c5

Browse files
authored
Update README.md
1 parent 69fe6bc commit cd4a0c5

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,37 @@
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+
[![CocoaPods](https://img.shields.io/cocoapods/v/TinyCrayon.svg)](https://cocoapods.org/pods/TinyCrayon)
7+
[![App Store](https://img.shields.io/badge/app%20store-sample%20apps-orange.svg)](https://itunes.apple.com/us/developer/yongyun-zeng/id1071044410)
8+
[![license](https://img.shields.io/cocoapods/l/TinyCrayon.svg)](https://github.com/TinyCrayon/TinyCrayon-iOS-SDK/blob/master/LICENSE)
9+
10+
TinyCrayon SDK provides tools for adding image cutout and layer mask capabilities to your mobile applications.
11+
12+
![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)
13+
------------ | -------------
14+
Quick Select Tool | Hair Brush Tool
15+
16+
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).
17+
18+
## Table of Contents
19+
20+
* [Overview](#overview)
21+
* [Features](#features)
22+
* [Installation](#installation)
23+
* [Prerequisites](#prerequisites)
24+
* [Streamlined, using CocoaPods](#streamlined-using-cocoapods)
25+
* [Manually, using the SDK download](#manually-using-the-sdk-download)
26+
* [Download the SDK](#download-the-sdk)
27+
* [Add the framework](#add-the-framework)
28+
* [Settings for Objective-C](#settings-for-objective-c)
29+
* [Usage](#usage)
30+
* [Add a TCMaskView](#add-a-tcmaskview)
31+
* [TCMask class](#tcmask-class)
32+
* [Further reading](#further-reading)
33+
* [License](#license)
34+
* [Terms of use](#terms-of-use)
235

336
## Overview
437
TinyCrayon SDK provides tools for adding image cutout and layer mask capabilities to your mobile applications.
@@ -10,12 +43,6 @@ The current version of TinyCrayon SDK provides the following three tools:
1043
* 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.
1144
* Regular Brush: A regular brush tool with the capability to adjust its size, hardness and opacity.
1245

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-
17-
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).
18-
1946
## Features
2047
* Free: TinyCrayon SDK is provided under MIT license, you can use it in your commercial applications for free!
2148
* iPad support: TinyCrayon SDK uses auto layout for its views and adapts to each screen size - iPhone or iPad.

0 commit comments

Comments
 (0)