From 98f618f761187e209b17bf8eb9328ac19ec9c83f Mon Sep 17 00:00:00 2001
From: Nathan <148575555+nathan-artie@users.noreply.github.com>
Date: Fri, 26 Jan 2024 12:51:06 -0800
Subject: [PATCH] Add PostgreSQL to README (#45)

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2063ee4f..d78a358b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 <div align="center">
   <img height="150px" src="https://github.com/artie-labs/transfer/assets/4412200/238df0c7-6087-4ddc-b83b-24638212af6a"/>
   <h3>Artie Reader</h3>
-  <p><b>📚 Grabbing data changes from various sources such as DynamoDB 📚</b></p>
+  <p><b>📚 Grabbing data changes from various sources such as PostgreSQL & DynamoDB 📚</b></p>
   <a href="https://artie.so/slack"><img src="https://img.shields.io/badge/slack-@artie-blue.svg?logo=slack"/></a>
   <a href="https://github.com/artie-labs/reader/blob/master/LICENSE.txt"><img src="https://user-images.githubusercontent.com/4412200/201544613-a7197bc4-8b61-4fc5-bf09-68ee10133fd7.svg"/></a>
   <img src="https://github.com/artie-labs/reader/actions/workflows/gha-go-test.yaml/badge.svg"/>
@@ -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