From 08b7ebf6d867542f17379def50d785ed8f1f4e1a Mon Sep 17 00:00:00 2001
From: RouxAntoine <antoinroux@hotmail.fr>
Date: Thu, 5 Sep 2024 22:37:29 +0200
Subject: [PATCH] doc: complete readme

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0053a0d..f10a2a8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
 # setup-netcat
 
-GiHhub action to setup netcat on an ubuntu runner with the apt package manager
+GiHhub action to set up netcat on an ubuntu runner with the apt package manager
+
+usage example
+
+```yaml
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: runner
+    steps:
+      - name: Setup netcat tools
+        uses: RouxAntoine/setup-netcat@v1.0.0
+        id: setup-netcat
+```