Skip to content

Fix issue on sample code - require usage #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tiagojsag wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix issue on sample code - require usage #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ s3cmd: [s3-cli](https://github.com/andrewrk/node-s3-cli).
### Create a client

```js
var s3 = require('s3');
var s3 = require('@auth0/s3');

var client = s3.createClient({
maxAsyncS3: 20, // this is the default
Expand All @@ -52,7 +52,7 @@ var client = s3.createClient({
### Create a client from existing AWS.S3 object

```js
var s3 = require('s3');
var s3 = require('@auth0/s3');
var awsS3Client = new AWS.S3(s3Options);
var options = {
s3Client: awsS3Client,
Expand Down Expand Up @@ -618,7 +618,7 @@ Using the AWS SDK, you can send a HEAD request, which will tell you if a file ex
See http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#headObject-property

```js
var client = require('s3').createClient({ /* options */ });
var client = require('@auth0/s3').createClient({ /* options */ });
client.s3.headObject({
Bucket: 's3 bucket name',
Key: 'some/remote/file'
Expand Down