Update docs and CI

MetroStar · May 17, 2024 · c64e8c7 · c64e8c7
1 parent 3a8682d
commit c64e8c7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/.github/workflows/paradrop.yml b/.github/workflows/paradrop.yml
@@ -21,7 +21,11 @@ jobs:
           go-version: ">=1.22.3"
 
       - name: Build paradrop-agent Binary
-        run: cd agent && make lint && make
+        run: |
+        go install honnef.co/go/tools/cmd/staticcheck@latest
+        curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.58.1
+        curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s -- -b $(go env GOPATH)/bin vX.Y.Z
+        cd agent && make lint && make
 
       - name: Set Up Python 3.12
         uses: actions/setup-python@v5

diff --git a/README.md b/README.md
@@ -37,14 +37,16 @@ Go to https://localhost:8443/ui/
 ## ⚙️ Development
 
 ### `Opensearch`
+Elasticsearch compatible database also works
 
 > 🔔 Requires cURL, Make and Docker
 
 ```bash
 make elk
 ```
 
-### `api`
+### `api` 
+Python Flask API
 
 > 🔔 Requires Python >=3.10.
 
@@ -53,6 +55,7 @@ make api
 ```
 
 ### `ui`
+Bootstrap 5 & CoreUI Static HTML/CSS/JS
 
 > 🔔 Requires Python 3.x or serve static assets from build UI directory.
 
@@ -61,7 +64,7 @@ make ui
 ```
 
 ### `agent`
-
+Golang Agent (Windows/Linux/Darwin/amd64/arm64 supported)
 > 🔔 Requires Go >=1.22 
 
 ```bash