Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
songjiayang committed Jan 19, 2018
1 parent e5d835f commit 28e03d9
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# s3sync
Local files auto sync to cloud storages with S3API.

It cached file's `mtime` and `fsize` for performance, so it can sync the difference only.
It cached file's `mtime` and `fsize` for performance, so sync the difference only.

### Installation

Use `go get github.com/songjiayang/s3sync` or download the binary [relelase](https://github.com/songjiayang/s3sync/releases).

### Configuration

s3sync run with default config file `config.json`, of course you can change it with `-config` option.
`s3sync` run with config file `config.json`, of course you can change it with `-config` option.

The config detail infomation is:
The config details are:

```
{
"root": "~",
"root": "/home/user/example", // target folder
"scan_worker": 20, // the number of works to scan the files changes.
"db": "./data/db", // cache files
"s3sync": {
Expand All @@ -36,7 +36,7 @@ The config detail infomation is:

### Usage

you can run `s3sync -h` to get all the options:
You can run `s3sync -h` to check all options:

```
-config string
Expand All @@ -55,6 +55,8 @@ you can run `s3sync -h` to get all the options:
-d run sync task backgound with interval time, default: 30s
```

Use case example:

- sync files upload only

```
Expand Down Expand Up @@ -107,4 +109,4 @@ Tips: If you want auto sync, use `-d` option please.

- AWS
- Qiniu
- S3 Protocol Compatible Storage
- S3 Protocol Compatible Storage

0 comments on commit 28e03d9

Please sign in to comment.