Merge pull request #9 from robgonnella/update-readme

Add info about pre-built binaries in README

.github/workflows/coverage.yml → .github/workflows/test-coverage.yml

@@ -1,4 +1,4 @@
-name: Generate code coverage badge
+name: Test
 
 on:
   pull_request:
@@ -8,7 +8,7 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-    name: Update coverage badge
+    name: Test and update coverage badge
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -32,7 +32,7 @@ jobs:
       - name: Go Coverage Badge
         uses: tj-actions/coverage-badge-go@v2
         with:
-          filename: coverage.txt
+          filename: coverage/coverage.txt
 
       - name: Verify Changed files
         uses: tj-actions/verify-changed-files@v16

.github/workflows/test.yml

@@ -1,9 +1,9 @@
-name: Go test
+name: Build and Test
 
 on:
   push:
     branches:
-      - '*'
+      - main
     tags:
       - '!v*'
 

README.md

@@ -1,4 +1,5 @@
 # go-lanscan
+![Coverage](https://img.shields.io/badge/Coverage-1-red)
 
 A network cli and golang package that allows you to perform arp and syn
 scanning on a local area network.
@@ -22,6 +23,12 @@ Once dependencies are installed, run the following command to install go-lanscan
 go install github.com/robgonnella/go-lanscan@latest
 ```
 
+### Pre-built Binaries
+
+Some pre-built binaries are provided in the releases section of github:
+https://github.com/robgonnella/go-lanscan/releases. These binaries still have
+a prerequisite on libpcap being installed first.
+
 ### Usage
 
 ```bash