From 29afb14f353e20ff6aa41052d289abe9284b3f28 Mon Sep 17 00:00:00 2001
From: QuentinN42 <quentin@lieumont.fr>
Date: Wed, 16 Aug 2023 16:23:02 +0200
Subject: [PATCH 1/2] docs: Requirements and Install

Signed-off-by: QuentinN42 <quentin@lieumont.fr>
---
 README.md                    | 32 ++++++++++++++++++++++++++++++++
 examples/docker-compose.yaml | 10 ++++++++++
 2 files changed, 42 insertions(+)
 create mode 100644 examples/docker-compose.yaml

diff --git a/README.md b/README.md
index 2ebc698..ab8df97 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
 # Escape proxy
 
 A simple proxy that can be used to allow escape to connect to some APIs.
+
+## Requirements
+
+To use this proxy, you need to have an [Escape](https://escape.tech) account.
+
+Before installing the proxy make shure you have the following:
+
+- `ESCAPE_ORGANIZATION_ID` : Your Escape organization id (can be found in [organization/settings](https://app.escape.tech/organization/settings/)).
+- `ESCAPE_API_KEY` : The API key of your Escape account (can be found in [user/profile](https://app.escape.tech/user/profile/)).
+
+## Install
+
+You have multiple options to install the proxy:
+
+- Docker image (covered in this tutorial)
+- From source ([go to releases](https://github.com/Escape-Technologies/proxy/releases/latest))
+
+You now need to run the proxy with the following environment variables:
+
+- `ESCAPE_ORGANIZATION_ID`: Your organization id.
+- `ESCAPE_API_KEY` : Your API key.
+- `PORT` : The port on which the proxy will listen (default: `8080`).
+
+```bash
+docker run -it --rm --name escape-proxy \
+    -e ESCAPE_ORGANIZATION_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
+    -e ESCAPE_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
+    -p 8080:8080 escapetech/proxy
+```
+
+You can find in the example folder more deployment examples.
+Feel free to contribute and add your own.
diff --git a/examples/docker-compose.yaml b/examples/docker-compose.yaml
new file mode 100644
index 0000000..2f6a09c
--- /dev/null
+++ b/examples/docker-compose.yaml
@@ -0,0 +1,10 @@
+version: "3.7"
+
+services:
+  proxy:
+    image: escapetech/proxy
+    ports:
+      - 8080:8080
+    environment:
+      - ESCAPE_ORGANIZATION_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+      - ESCAPE_API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

From d6d2312e9dd60e10aecb5b1bb8dff157e3830e5b Mon Sep 17 00:00:00 2001
From: QuentinN42 <quentin@lieumont.fr>
Date: Wed, 16 Aug 2023 16:42:26 +0200
Subject: [PATCH 2/2] feat: link to the docs

Signed-off-by: QuentinN42 <quentin@lieumont.fr>
---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index ab8df97..f456375 100644
--- a/README.md
+++ b/README.md
@@ -33,3 +33,7 @@ docker run -it --rm --name escape-proxy \
 
 You can find in the example folder more deployment examples.
 Feel free to contribute and add your own.
+
+## Usage
+
+You can now go to the escape documentation follow the steps to [use your custom proxy](https://docs.escape.tech/cookbooks/identifying-requests#using-a-custom-proxy).