Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
clineamb committed Oct 13, 2015
1 parent a226ac4 commit 1831dec
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
18 changes: 16 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# gulp-s3-upload
__Version 1.4.2__
__Version 1.4.3__

Use for uploading assets to Amazon S3 servers.
This helps to make it an easy gulp task.
Expand All @@ -23,9 +23,23 @@ __See full details in the [Changelog](docs/changelog.md).__
var s3 = require('gulp-s3-upload')(config);
```

...where config is something like...

```js
var config = {
accessKeyId: "YOURACCESSKEY",
accessKeySecret: "YOUACCESSSECRET"
}

// ...or...

var config = JSON.parse(fs.readFileSync('private/awsaccess.json'));

```

The optional `config` argument can include any option available (like `region`) available in the [AWS Config Constructor](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#constructor-property). By default all settings are undefined.

Per AWS best practices, the recommended approach for loading credentials is to use the shared credentials file (`~/.aws/credentials`). You can also set the `aws_access_key_id` and `aws_secret_access_key` environment variables or specify values directly in the gulpfile via the `accessKeyId` and `secretAccessKey` options. If you have multiple profiles configured in your AWS credentials file, you can specify the profile name inline with the call to gulp.
**Per AWS best practices**, the recommended approach for loading credentials is to use the shared credentials file (`~/.aws/credentials`). You can also set the `aws_access_key_id` and `aws_secret_access_key` environment variables or specify values directly in the gulpfile via the `accessKeyId` and `secretAccessKey` options. If you have multiple profiles configured in your AWS credentials file, you can specify the profile name inline with the call to gulp.

```sh
AWS_PROFILE=myprofile gulp
Expand Down
7 changes: 7 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## Version 1.4.3
* Fix issue [issue #26](http://github.com/clineamb/gulp-s3-upload/issues/23)
* Move things into `s3.headObject` call to prevent mutable variable errors.
* Clean up some comments.
* Update Readme to clarify `config` hash in the config section.


## Version 1.4.2

* Update file-hashing function with [hasha](http://github.com/sindresorhus/hasha) from a signature change. Simply pull file buffer instead of promise for simplicity sake.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "gulp-s3-upload",
"version": "1.4.2",
"version": "1.4.3",
"description": "A gulp task to asynchronous upload/update assets to an AWS S3 Bucket.",
"main": "index.js",
"directories": {
Expand Down

0 comments on commit 1831dec

Please sign in to comment.