From 83f98945224adaa56b4beac1b4e258c832a9635f Mon Sep 17 00:00:00 2001
From: pouriyajamshidi <pouriya.jamshidi@gmail.com>
Date: Fri, 8 Nov 2024 16:39:20 +0100
Subject: [PATCH] add flags and restructure the contents

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5a36941..31ba049 100755
--- a/README.md
+++ b/README.md
@@ -8,7 +8,22 @@ This repo is the companion to my blog posts about eBPF at <https://thegraynode.i
 
 ## Running The Program
 
-Clone the repository.
+You can install **flat** in two ways.
+
+1. Download the [pre-compiled binary](#download-the-pre-compiled-binary)
+2. Compile from [source](#compile-from-source)
+
+### Download The Pre-compiled Binary
+
+```bash
+wget https://github.com/pouriyajamshidi/flat/releases/latest/download/flat
+```
+
+Then check out the [examples](#examples).
+
+### Compile From Source
+
+Clone the repository:
 
 ```bash
 git clone https://github.com/pouriyajamshidi/flat .
@@ -32,13 +47,34 @@ Compile the **Go** program:
 go build -ldflags "-s -w" -o flat cmd/flat.go
 ```
 
+### Examples
+
 Run it with elevated privileges:
 
 ```bash
 # Replace eth0 with your desired interface name
 sudo ./flat -i eth0
+# Or
+sudo ./flat -i eth0 -ip 1.1.1.1
+# Or
+sudo ./flat -i eth0 -port 53
+# Or
+sudo ./flat -i eth0 -ip 1.1.1.1 -port 53
 ```
 
+## Flags
+
+**flat** supports four flags at the moment:
+
+| flag  | Description                         |
+| ----- | ----------------------------------- |
+| -i    | interface to attach the probe to    |
+| -ip   | IP address to filter on (optional)  |
+| -port | Port number to filter on (optional) |
+| -h    | Show help message                   |
+
+---
+
 ## Acknolegments
 
 Heavily inspired by [flowlat](https://github.com/markpash/flowlat).