From 0eb1e9055dc34b8d75b84bb905c30b9bc60f505f Mon Sep 17 00:00:00 2001
From: tomoron <tomoron@student.42angouleme.fr>
Date: Tue, 3 Jun 2025 02:04:52 +0200
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eb36865
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# ft_ping
+## Why ?
+This project is a good way to understand how icmp and ip communication work (at a high level).
+After doing this project, I know how the unix ping command work
+
+## Compilation
+To compile this project, just execute the command `make` at the root of the project.
+
+## Usage
+```
+sudo ./ft_ping [options] <destination>...
+```
+
+example: 
+```
+sudo ./ft_ping -W 1 localhost -v google.fr -c 2
+```
+
+## limitations
+
+* needs super user right to run
+* only supports IPv4
+
+## bonus options
+
+* --ttl
+* --count (-c)
+* --linger (-W)
+* --timeout (-w)
+* --interval (-i)
+