From fde387ab2950b831c026f4279d843f91083b9683 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Philip=20Dub=C3=A9?= <serprex@users.noreply.github.com>
Date: Tue, 20 Aug 2024 17:35:22 +0000
Subject: [PATCH] README.md (#12)

---
 README.md | 3 +++
 1 file changed, 3 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..302a945
--- /dev/null
+++ b/README.md
@@ -0,0 +1,3 @@
+`peerdb_fdw` is a copy of postgres_fdw with a couple adjustments to improve usability with PeerDB's query layer.
+
+First, some cost adjustments were made to encourage pushing down everything. Second, a UDF `peerdb_exec` using code from dblink was put together so that users can explicitly craft queries if postgres planner isn't playing along or they have specific syntax for PeerDB