Skip to content

Latest commit

 

History

History
44 lines (38 loc) · 1.06 KB

README.md

File metadata and controls

44 lines (38 loc) · 1.06 KB

swint-s3upload

Greenkeeper badge AWS S3 uploader for Swint batch task manager(swint-task)

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

Installation

$ npm install --save swint-s3upload

Testing

You may save your secret credentials for the test at $HOME/.swint/swint-s3upload-test.json in the format below:

{
	"id": "ADJFNAIAMYAWSID",
	"secret": "DEJNARGMKAJENVADMMYAWSSECRET",
	"bucket": "swint-secret"
}

Options

  • inDir : String, default: path.join(path.dirname(require.main.filename), '../out')
  • outDir : String, default: ''
  • s3Info
    • key : String, default: 'key'
    • secret : String, default: 'secret'
    • bucket : String, default: 'bucket'

Usage

swintS3Upload({
	inDir: path.join(__dirname, 'out'),
	outDir: '',
	s3Info: {
		key: cred.id,
		secret: cred.secret,
		bucket: cred.bucket
	}
}, function(err, res) {
	// Afterwards...
});