Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 3 KB

README.md

File metadata and controls

69 lines (52 loc) · 3 KB
Raw

Read this in other languages: English,简体中文.

Build Status Download

TinyPngPlugin

TinyPngPlugin is a Gradle plugin for TinyPng, can batch optimize your images.

Get Tiny API key

Before use this plugin, you need get a Tiny API Key first. Goto Tiny Developers Page, input your email and name to get the key.

Notice: The first 500 compressions each month are free. You will only be billed if you compress more than 500 images.

Getting Started

Add TinyPngPlugin as a dependency in your main build.gradle in the root of your project:

dependencies {
	classpath 'com.waynell.tinypng:TinyPngPlugin:1.0.5'
}

Then you need to apply the plugin and configure your tinyinfo by adding the following lines to your app/build.gradle:

apply plugin: 'com.waynell.tinypng'

tinyInfo {
	resourceDir = [
		// your res dir
        "app/src/main/res",
        "lib/src/main/res"
	]
    resourcePattern = [
    	// your res pattern
    	"drawable[a-z-]*",
        "mipmap[a-z-]*"
    ]
    whiteList = [
    	// your white list, support Regular Expressions
    ]
    apiKey = 'your tiny API key'
}

If you are using Android Studio, you can find the generate task option in tinypng group. Or alternatively, you run ./gradlew tinyPng in your terminal.

TinyPngPlugin has a compressed-resource.json file to record the compressed result, next time TinyPngPlugin will skip these files that have been compressed.

Thanks

TinyPIC_Gradle_Plugin

Licence

MIT License

Copyright (c) 2016 Wayne Yang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.