Skip to content

Commit 12e4da1

Browse files
committed
Improve documentation
1 parent c8072c2 commit 12e4da1

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# buffer-static-upload
22

3-
A straightforward static asset uploader which generates a json file for your
4-
application to read the uploaded file locations from.
3+
A straightforward static asset uploader which versions files by their contents
4+
and generates a json file for your application to read the uploaded file
5+
locations from.
56

67
## Usage
78

@@ -24,7 +25,17 @@ Usage of buffer-static-upload:
2425
For example, you can use glob patterns to match multiple sets of files:
2526

2627
```
27-
buffer-static-upload -files "public/js/**/*.js,public/css/*.css"
28+
buffer-static-upload -files "public/js/**/*.js,public/css/*.css" -bucket my-bucket
29+
```
30+
31+
This will generate a `staticAssets.json` file in this directory like this:
32+
33+
```json
34+
{
35+
"public/css/style.css": "https://my-bucket.s3.amazonaws.com/public/css/style.11985b07e3121564a73d4d6821bfcfe7.css",
36+
"public/js/x/another.js": "https://my-bucket.s3.amazonaws.com/public/js/x/another.bfa2d0f60841707efe7be0a94c4caacf.js",
37+
"public/js/script.js": "https://my-bucket.s3.amazonaws.com/public/js/script.d55002b60fcfff0b3d355184d23af6f7.js"
38+
}
2839
```
2940

3041
*Note* - The default bucket is used by multiple teams, so if you use that you

0 commit comments

Comments
 (0)