From 09473e4bab1615ec03025725065a47f1212a226d Mon Sep 17 00:00:00 2001 From: Qingping Hou Date: Sun, 8 Mar 2020 16:24:29 -0700 Subject: [PATCH] docs: update readme to add more use-case --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0b55e92..c842f74 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ ObjInSync ![CI/CD](https://github.com/scribd/objinsync/workflows/CI/CD/badge.svg) -Daemon to continuously synchronize a directory from remote object store to a local directory. +Daemon to continuously and incrementally synchronize a directory from remote +object store to a local directory. Usage @@ -13,18 +14,24 @@ Usage objinsync pull --exclude '**/__pycache__/**' s3://bucket/keyprefix ./localdir ``` -When running in daemon mode (without `--once` flag), a healthcheck endpoint is +When running in daemon mode (without `--once` flag), a health check endpoint is served at `:8087/health` and a prometheus metrics endponit is served at `:8087/metrics`. You can use `--status-addr` to override the binding address. Objinsync also comes with builtin Sentry integration. To enable it, set the `SENTRY_DSN` environment variable. +You can also run objinsync in pull once mode, which behaves just like `aws s3 sync`: + +```bash +objinsync pull --once s3://bucket/keyprefix ./localdir +``` + Installation ------------ -Simply download the prebuilt binary from [release page](https://github.com/scribd/objinsync/releases) or use `go get` command: +Simply download the prebuilt single binary from [release page](https://github.com/scribd/objinsync/releases) or use `go get` command: ```bash go get github.com/scribd/objinsync @@ -46,4 +53,4 @@ Run from source AWS_REGION=us-east-2 go run main.go pull s3://qph-test-airflow-airflow-code/airflow_home/dags ./dags ``` -To cut a release, push tag to remote with format of `vx.x.x`. +To cut a release, push tag to remote in the format of `vx.x.x`.