Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.16 KB

README.md

File metadata and controls

79 lines (55 loc) · 2.16 KB

icon-toolkit

Dynamic app icon generator for iOS, Android

NPM version Build Status Coverage Status Code Climate Dependency Status devDependency Status

Installation

npm install --save icon-toolkit

Usage

IconToolkit API is Promise based

Usage 1 (Basic):

import IconToolkit from 'icon-toolkit'

IconToolkit.generateIcons({
  source: '/Users/userX/sourceImage.png'),
  destinationFolder: '/Users/userX/exportIcons')
}).then(() => console.log('SUCCESS!'))

Usage 2 (iOS / Android split):

import IconToolkit from 'icon-toolkit'

IconToolkit.generateIcons({
  source: '/Users/userX/sourceImage.png'),
  ios: {
    destinationFolder: '/Users/userX/myIosIcons')
  },
  android: {
    destinationFolder: '/Users/userX/myAndroidIcons')
  }
}).then(() => console.log('SUCCESS!'))

Usage 3 (Advanced):

import IconToolkit from 'icon-toolkit'

IconToolkit.generateIcons({
  ios: {
    source: '/Users/userX/iOSImage.png'),
    destinationFolder: '/Users/userX/myIosIcons')
  },
  android: {
    source: '/Users/userX/androidImage.png'),
    destinationFolder: '/Users/userX/myAndroidIcons')
  }
}).then(() => console.log('SUCCESS!'))

Output

iOS Android
iOS Android

Contributing

Basicaly clone, change, test, push and pull request.

License

icon-toolkit is licensed under the MIT license.