Skip to content
This repository was archived by the owner on Nov 17, 2025. It is now read-only.

Commit debaea7

Browse files
committed
fix documentation, bump version, and prepare for npm publish
1 parent fe6dbf2 commit debaea7

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Synchronise a local directory with AWS CloudFront / S3, maintaining correct headers, etc.
44

5-
**This project is not yet functional.**
5+
Functionality is sufficient to replace s3cmd with better MIME detection.
66

77
## Goals
88

@@ -96,7 +96,28 @@ _(Coming soon)_
9696
_(Coming soon)_
9797

9898
## Examples
99-
_(Coming soon)_
99+
100+
### Example .cdn-sync.json
101+
102+
```
103+
{
104+
"targets": [
105+
{
106+
"type": "aws",
107+
"options": {
108+
"accessKeyId": "...",
109+
"secretAccessKey": "...",
110+
"region": "...",
111+
"sslEnabled": true,
112+
"Bucket": "..."
113+
},
114+
"strategy": ["clone"]
115+
}
116+
]
117+
}
118+
```
119+
120+
Note: for targets[index].options, use the options you would pass to the [AWS.S3 constructor](http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3_20060301.html#constructor-property).
100121

101122
## Contributing
102123
Formal styleguide for this project is JSLint. See JSLint settings at the top of

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "cdn-sync",
3-
"description": "deflate / synchronous assets to a CDN",
4-
"version": "0.0.1",
3+
"description": "deflate / synchronise assets to a CDN",
4+
"version": "0.1.0",
55
"homepage": "https://github.com/jokeyrhyme/cdn-sync",
66
"author": {
77
"name": "Ron Waldon",

0 commit comments

Comments
 (0)