doc: complete readme

2024-09-05 22:37:29 +02:00 · 2024-09-05 22:37:29 +02:00 · 08b7ebf6d8
commit 08b7ebf6d8
parent acd91548d4
1 changed files with 20 additions and 1 deletions
--- 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
+```