Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.03 KB

README.md

File metadata and controls

33 lines (27 loc) · 1.03 KB

swint-builder-png

Greenkeeper badge PNG sprite builder for Swint

Warning: This is not the final draft yet, so do not use this until its official version is launched

Dependency

ImageMagicK should be installed and able to execute $ convert and $ montage on the command line

Installation

$ npm install --save swint-builder-png

Options

  • name : String, default: Project
  • inDir : String, default: path.dirname(require.main.filename)
  • outDir : String, default: path.join(path.dirname(require.main.filename), '../out')
  • imgMetaDir : String, default: path.join(path.dirname(require.main.filename), '../imgMeta')
  • walkOption : Object, default: { ext: '*' }

Usage

buildPNG({
	name: 'Test',
	inDir: path.join(__dirname, 'png'),
	outDir: path.join(__dirname, 'out'),
	imgMetaDir: path.join(__dirname, 'imgMeta')
}, function() {
	// Build complete
});