From 884018a90dea0bc34fdd4d83672dd2d755831870 Mon Sep 17 00:00:00 2001
From: Pierre Hubert <pierre.git@communiquons.org>
Date: Tue, 30 Aug 2022 15:26:23 +0200
Subject: [PATCH] Add readme

---
 README.MD | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.MD

diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..2007351
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,22 @@
+# TCP over HTTP
+This project aims to provide an easy-to-setup TCP forwarding solution:
+
+```
+|--------|              |--------|                     |--------|              | -------|
+|        |              | Client |                     | Server |              |        |
+| Client | -- TCP xx -- |        | -- HTTP 80 / 443 -- |        | -- TCP xx -- | Server |
+|        |              |  Relay |                     |  Relay |              |        |
+|--------|              |--------|                     |--------|              |--------|
+```
+
+This project can be used especially to bypass firewalls that blocks traffics
+from ports others than the 80 / 443 duo.
+
+This repository contains two binaries:
+
+* `tpc_relay_server`: The server relay
+* `tcp_relay_client`: The client relay
+
+The clients relay authenticates itself to the server using a token.
+
+A single server - client relay pair can relay multiple ports simultaneously from the same machine.