Usage example in README.md

ydb-platform · Dec 18, 2023 · 24f4481 · 24f4481
1 parent 36a3dd1
commit 24f4481
Showing 1 changed file with 11 additions and 2 deletions.
diff --git 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
+```