diff --git a/README.md b/README.md index 2063ee4f..d78a358b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
📚 Grabbing data changes from various sources such as DynamoDB 📚
+📚 Grabbing data changes from various sources such as PostgreSQL & DynamoDB 📚
@@ -12,7 +12,7 @@ ## Getting this running -Generate a `config.yaml` file with the following contents: +For DynamoDB create a `config.yaml` file with the following contents: ```yaml source: dynamodb @@ -30,6 +30,26 @@ kafka: topicPrefix: topicPrefix ``` +For PostgreSQL create a `config.yaml` file with the following contents: + +```yaml +source: postgresql + +postgresql: + host: hostname + port: 5432 + userName: username + password: password + database: postgres + tables: + - name: table + schema: public + +kafka: + bootstrapServers: localhost:29092 + topicPrefix: topicPrefix +``` + Then run the following command: ```bash @@ -38,3 +58,4 @@ go run main.go --config config.yaml ## What is currently supported? * DynamoDB (via DynamoDB streams) +* PostgreSQL