Skip to content

Commit

Permalink
Merge pull request #18 from ggoforth/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
DanielHindi authored Dec 11, 2017
2 parents 5a34bfb + 076def9 commit dd41278
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Amazon S3 Zipping tool (aws-s3-zipper)

## What does it do?
###1. Zips S3 files
### 1. Zips S3 files
Takes an amazon s3 bucket folder and zips it to a:
* Stream
* Local File
* Local File Fragments (zip multiple files broken up by max number of files or size)
* S3 File (ie uploads the zip back to s3)
* S3 File Fragments (upload multiple zip files broken up by max number of files or size)

###2. Differential zipping
### 2. Differential zipping
It also allows you to do *differential* zips. You can save the key of the last file you zipped and then zip files that have been uploaded after the last zip.

###3. Fragmented Zips
### 3. Fragmented Zips
If a zip file has the potential of getting too big. You can provide limits to breakup the compression into multiple zip files. You can limit based on file count or total size (pre zip)

###4. Filter Files to zip
### 4. Filter Files to zip
You can filter out files you dont want zipped based on any criteria you need



##How do i use it?
## How do i use it?
### Setup
```
var S3Zipper = require ('aws-s3-zipper');
Expand All @@ -34,7 +34,7 @@ var config ={
var zipper = new S3Zipper(config);
```

###Filter out Files
### Filter out Files
```
zipper.filterOutFiles= function(file){
if(file.Key.indexOf('.tmp') >= 0) // filter out temp files
Expand Down Expand Up @@ -126,7 +126,7 @@ zipper.zipToS3FileFragments({
});
```

##The Details
## The Details
### `init`
Either from the constructor or from the `init(config)` function you can pass along the AWS config object
```
Expand Down Expand Up @@ -220,4 +220,4 @@ Zip files to a local zip file.
* `recursive`: bool optional. to zip nested folders or not
* `callback(err,result)`: call this function when done
* `err`: the error object if any
* `results`: the array of results
* `results`: the array of results

0 comments on commit dd41278

Please sign in to comment.