From c583f63b6cd83f0f7529d6c2f539503c16e1929e Mon Sep 17 00:00:00 2001
From: William Petit <wpetit@cadoles.com>
Date: Wed, 28 Feb 2024 09:23:52 +0100
Subject: [PATCH] doc: update readme

---
 README.md | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 4d0a270..73ba7af 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,23 @@
 # Rebound
 
-Serveur utilisant le protocole SSH pour créer des tunnels TCP/IP.
+An TCP tunneling server requiring only a SSH client.
 
 ## Usage
 
-### Ouvrir un tunnel sur un port local
+We wants to access `<local_address>:<local_port>` from machine A's network as `<target_port>` on machine B.
+
+### Opening the tunnel on machine A
 
 ```shell
-ssh -R 0:<target_address>:<target_port> root@rebound.lookingfora.name -p 2222
+ssh -R 0:<local_address>:<local_port> root@rebound-server -p 80
 ```
 
-### Se connecter à un tunnel ouvert
+### Connecting to the tunnel on machine B
 
-```
-ssh -L <local_port>:0.0.0.0:1 <secret>@rebound.lookingfora.name -p 2222
+```shell
+ssh -L <target_port>:0.0.0.0:1 <secret>@rebound-server -p 80
 ```
 
-Vous pourrez ensuite accéder au service sur `127.0.0.1:<local_port>` comme si c'était `<target_address>:<target_port>`.
\ No newline at end of file
+## Licence
+
+[AGPL-3.0](./LICENCE.md)
\ No newline at end of file