From a169d72698f25907946e1f37f0e59796363f4237 Mon Sep 17 00:00:00 2001
From: Mahdi Dibaiee <mdibaiee@pm.me>
Date: Mon, 15 Mar 2021 09:10:05 +0000
Subject: [PATCH] feat: add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88ba8e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+tls-forward-proxy
+=================
+
+A most basic forward proxy using [Tokio](https://tokio.rs/) [TcpStreams](https://docs.rs/tokio/1.3.0/tokio/net/struct.TcpStream.html).
+
+Sample usage:
+```
+$ cargo build && cargo run
+Listening on 127.0.0.1:8080
+```
+
+Send requests to your destination through this proxy:
+```
+curl --cacert /path/to/cert.pem https://test.dev:5000 -x http://proxy.dev:8080 --proxytunnel
+```