From 1bdd546fbb19c3df3b4cfa7b4172b16481139203 Mon Sep 17 00:00:00 2001
From: Lev Kokotov <lev.kokotov@gmail.com>
Date: Thu, 3 Feb 2022 16:29:57 -0800
Subject: [PATCH] README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9004c9e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# PgCat
+
+Meow. PgBouncer rewritten in Rust, with sharding, load balancing and failover support.
+
+**Alpha**: don't use in production just yet.
+
+## Local development
+
+1. Install Rust (latest stable is fine).
+2. `cargo run --release` (to get better benchmarks)
+
+## Features
+
+1. Session mode
+2. Transaction mode (basic)
+
+## Missing
+
+1. `COPY` support
+2. All the features I promised above. Will make them soon, promise :-).