Skip to content
This repository has been archived by the owner on Jul 27, 2019. It is now read-only.

Commit

Permalink
Updated anchors for gfm.
Browse files Browse the repository at this point in the history
  • Loading branch information
ashryanbeats committed Aug 12, 2016
1 parent 73dee88 commit 55eacf1
Showing 1 changed file with 6 additions and 62 deletions.
68 changes: 6 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,17 @@ This plugin makes it possible for you to use the Creative SDK Image Editor in yo

### Contents

- [Prerequisites](#prereqs)
- [Installation](#install)
- [Setup guide](#setup)
- [Sample code](#sample)
- [API guide](#api)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Setup guide](#setup-guide)
- [Sample code](#sample-code)
- [API guide](#api-guide)

<a name="prereqs"></a>
# Prerequisites

**Required:** This guide will assume that you have installed all software and completed all of the steps in the [Client Auth guide](https://github.com/CreativeSDK/phonegap-plugin-csdk-client-auth).


<a name="install"></a>
# Installation

## Adding the plugin
Expand All @@ -69,7 +67,6 @@ The ZIP files contain all the frameworks in the Creative SDK, but for this plugi
No action is required for Android. The Creative SDK for Android is delivered as a remote Maven repository, and the required framework will be downloaded automatically by the plugin.


<a name="setup"></a>
# Setup guide

1. `cd` into your existing PhoneGap app (must already include [Client Auth](https://github.com/CreativeSDK/phonegap-plugin-csdk-client-auth))
Expand All @@ -78,7 +75,6 @@ No action is required for Android. The Creative SDK for Android is delivered as
1. Build and run for your platform


<a name="sample"></a>
# Sample code

## `www/index.html`
Expand Down Expand Up @@ -156,58 +152,6 @@ var app = {
```


<a name="api"></a>
# API guide

## Global object

`CSDKImageEditor`

## Functions

`CSDKImageEditor.edit(successCallback, errorCallback, imageUrl[, options])`

- `successCallback()` receives one argument `newUrl`, which is the edited image
- `errorCallback()` receives one argument `error`
- `imageUrl` is a string URL location of the original image you want to edit
- `options` is an optional object you can pass. Will be set to `{}` if you don't pass this argument

## Options

You can pass the following property/value pairs in your `options` object:

- `outputType`
This property forces the specific output type that you set.

When no `outputType` option is passed, the default is to output the same file type that you pass in.

- `CSDKImageEditor.OutputType.PNG`
- `CSDKImageEditor.OutputType.JPEG`
- `tools`
This property lets you restrict the set of tools that are available to the user. The value for this property must be passed as an array of `CSDKImageEditor.ToolType` values.

When no `tools` option is passed, the default is to display all tools.

- `CSDKImageEditor.ToolType.SHARPNESS`
- `CSDKImageEditor.ToolType.EFFECTS`
- `CSDKImageEditor.ToolType.REDEYE`
- `CSDKImageEditor.ToolType.CROP`
- `CSDKImageEditor.ToolType.WHITEN`
- `CSDKImageEditor.ToolType.DRAW`
- `CSDKImageEditor.ToolType.STICKERS`
- `CSDKImageEditor.ToolType.TEXT`
- `CSDKImageEditor.ToolType.BLEMISH`
- `CSDKImageEditor.ToolType.MEME`
- `CSDKImageEditor.ToolType.ORIENTATION`
- `CSDKImageEditor.ToolType.ENHANCE`
- `CSDKImageEditor.ToolType.FRAMES`
- `CSDKImageEditor.ToolType.SPLASH`
- `CSDKImageEditor.ToolType.FOCUS`
- `CSDKImageEditor.ToolType.BLUR`
- `CSDKImageEditor.ToolType.VIGNETTE`
- `CSDKImageEditor.ToolType.LIGHTING`
- `CSDKImageEditor.ToolType.COLOR`
- `CSDKImageEditor.ToolType.OVERLAYS`
- `CSDKImageEditor.ToolType.ADJUST`
- `quality`
This property lets you set the quality of the output of the image. The value for this property can be a number from `1` to `100`, inclusive.
[See the full API guide](www/api.md).

0 comments on commit 55eacf1

Please sign in to comment.