From 24f44815e48eb9a393191e4945305f16ab702cc2 Mon Sep 17 00:00:00 2001 From: Vitaly Isaev Date: Mon, 18 Dec 2023 15:36:27 +0300 Subject: [PATCH] Usage example in README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6666b058..84bf8e54 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,16 @@ Currently supported data sources: * ClickHouse * PostgreSQL -### Contributing guide +### Usage -TODO +Use this command to run Connector with [default configuration](https://github.com/ydb-platform/fq-connector-go/blob/main/example.conf): +``` +docker run -d --name=connector -p 50051:50051 -p 6060:6060 ghcr.io/ydb-platform/fq-connector-go:latest +``` + +Or you can mount custom configuration into container: + +``` +docker run -it --name=connector -p 50051:50051 -p 6060:6060 -v /tmp/example.conf:/usr/local/etc/fq-connector.conf ghcr.io/ydb-platform/fq-connector-go:latest +```