Skip to content

Commit

Permalink
add dependencies and comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nuxusr committed Aug 3, 2010
1 parent 76feb66 commit 6f8a756
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
32 changes: 32 additions & 0 deletions README
@@ -0,0 +1,32 @@

Dallin Dyer

A simple S3 library written because the other implementation doesn't meet needs and is outdated.


What this library is good for:

Send files of any size (although S3 is currently limited at 5 gigs)
- file upload and downloads are streamed with a progress event fired during writes.

Minimal memory footprint and very efficient
- Streams files from disk to socket -- using nodes drain/pause/resume to only stream what socket/stream can take

Uses net sockets on PUT requests to support 100 Continue (especially usefull for large files)
- the body is only sent after amazon approves the signed header

Creats MD5 of content (optional)
- ensure your data isn't corrupted during transmission

Supports amazons new REDUCED_REDUNDANCY storage (cheaper but less reliable)
- see unit tests for examples

Supports specifying acl
- see unit tests for examples



Examples:
coming soon: check out / run unit tests for examples.


3 changes: 1 addition & 2 deletions test/test-s3-upload.js
Expand Up @@ -4,7 +4,7 @@ var RealAWSAccessKeyId = '';
var RealAWSSecretAccessKey = '';
var RealHosts = '[bucket-name].s3.amazonaws.com'


// note: these aren't real keys
var AWSAccessKeyId = '0PN5J17HBGZHT7JJ3X82';
var AWSSecretAccessKey = 'uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o';

Expand All @@ -14,7 +14,6 @@ var nodeunit = require('caolan-nodeunit/lib/nodeunit');
var sys = require('sys'),
spawn = require('child_process').spawn,
fs = require('fs');




Expand Down

0 comments on commit 6f8a756

Please sign in to comment.