#1: Cleanup README and remove push input

Author: JacobDomagala

.github/workflows/test_action.yml

@@ -12,7 +12,6 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Generate build badge
-        if: always()
         uses: DARMA-tasking/badge-generator@1-initial-version
         with:
           names: |

README.md

@@ -10,30 +10,38 @@ Generates a status badge using [Shields.io](https://shields.io) and commits it t
 |----------------|----------|------------------------------------------------------------------------|
 | `name`         | Yes      | Label for the badge (e.g., matrix item)                               |
 | `result`       | Yes      | Result of a previous step (`success` or `failure`).                   |
-| `github_token` | Yes      | GitHub token with **write access to the Wiki**.                       |
+| `github_token` | Yes      | GitHub token with **read/write access to the Wiki**.                       |
 
 ---
 
 
 ## Example
 
-```yaml
-    (...)
-    - name: Build
-      id: build
-      uses: docker/bake-action@v6
-      with:
-        source: .
-        targets: ${{ matrix.target }}
-        files: docker-bake.hcl
-        push: ${{ github.ref == 'refs/heads/develop' }}
-
-    - name: Generate build badge
-      if: always()
-      uses: DARMA-tasking/badge-generator@master
-      with:
-        name: ${{ matrix.image }}
-        result: ${{ steps.build.outcome }}
-        github_token: ${{ secrets.BADGE_TOKEN }}
-
 ```
+      - name: Generate build badge
+        uses: DARMA-tasking/badge-generator@master
+        with:
+          names: |
+            vt-build-amd64-alpine-3-16-clang-cpp
+            vt-build-amd64-ubuntu-20-04-gcc-9-cuda-12-2-0-cpp
+            vt-build-amd64-ubuntu-20-04-gcc-10-openmpi-cpp-spack
+            vt-build-amd64-ubuntu-22-04-gcc-12-cpp
+          results: |
+            success
+            cancelled
+            failure
+            failure
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+This will generate and commit to [wiki](https://github.com/DARMA-tasking/badge-generator.wiki.git) four badges:
+
+[![](https://github.com/DARMA-tasking/badge-generator/wiki/DARMA-tasking/badge-generator/vt-build-amd64-alpine-3-16-clang-cpp-badge.svg)]() <br>
+[![](https://github.com/DARMA-tasking/badge-generator/wiki/DARMA-tasking/badge-generator/vt-build-amd64-ubuntu-20-04-gcc-9-cuda-12-2-0-cpp-badge.svg)]() <br>
+[![](https://github.com/DARMA-tasking/badge-generator/wiki/DARMA-tasking/badge-generator/vt-build-amd64-ubuntu-20-04-gcc-10-openmpi-cpp-spack-badge.svg)]() <br>
+[![](https://github.com/DARMA-tasking/badge-generator/wiki/DARMA-tasking/badge-generator/vt-build-amd64-ubuntu-22-04-gcc-12-cpp-badge.svg)]() <br>
+
+Then we can reference those badges using the link:
+`https://github.com/DARMA-tasking/badge-generator/wiki/DARMA-tasking/{repository}/{workflow_name}-badge.svg`
+
+(**NOTE:** `github_token` has to be a token that grants **wiki** read/write permissions to `badge-generator` repository)

action.yml

@@ -13,9 +13,6 @@ inputs:
   github_token:
     description: 'GitHub token with permissions to write to the wiki.'
     required: true
-  push:
-    description: 'Whether to push to wiki repository or not'
-    default: true
 
 # Define the execution logic for the action
 runs:
@@ -58,7 +55,6 @@ runs:
         done
 
     - name: Commit and Push to Wiki
-      if: ${{ inputs.push == 'true' }}
       shell: bash
       run: |
         cd wiki