From 28a6e8aeb34b14bdf1560ca9f98179a3140dbd13 Mon Sep 17 00:00:00 2001
From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com>
Date: Fri, 14 Feb 2025 01:38:50 -0600
Subject: [PATCH] chore: update readme and update workflow [skip ci]

---
 .github/workflows/publish.yml | 20 +++++++++++---------
 README.md                     | 16 +++++++++++++++-
 2 files changed, 26 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 35187a8..909f5b6 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -64,18 +64,20 @@ jobs:
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: 9.x
+      - name: Build
+        run: dotnet build src
       - name: Publish for mac-os
         run: dotnet publish src/BGR.Console/BGR.Console.csproj -c Release -r osx-x64 --self-contained -o dist/mac-os
-      - name: Rename mac-os binary
-        run: mv dist/mac-os/BGR.Console dist/bgr_osx_x64
+      - name: Create zip for mac-os
+        run: zip -j dist/bgr_osx_x64.zip dist/mac-os/*
       - name: Publish for linux-os
         run: dotnet publish src/BGR.Console/BGR.Console.csproj -c Release -r linux-x64 --self-contained -o dist/linux-os
-      - name: Rename linux-os binary
-        run: mv dist/linux-os/BGR.Console dist/bgr_linux_x64
+      - name: Create zip for linux-os
+        run: zip -j dist/bgr_linux_x64.zip dist/linux-os/*
       - name: Publish for windows-os
         run: dotnet publish src/BGR.Console/BGR.Console.csproj -c Release -r win-x64 --self-contained -o dist/windows-os
-      - name: Rename windows-os binary
-        run: mv dist/windows-os/BGR.Console.exe dist/bgr_windows_x64.exe
+      - name: Create zip for windows-os
+        run: zip -j dist/bgr_windows_x64.zip dist/windows-os/*
       - name: Get project version
         uses: kzrnm/get-net-sdk-project-versions-action@v1
         id: get-version
@@ -95,6 +97,6 @@ jobs:
           draft: false
           body_path: src/BGR.Console/CHANGELOG.md
           files: |
-            dist/bgr_osx_x64
-            dist/bgr_linux_x64
-            dist/bgr_windows_x64.exe
+            dist/bgr_osx_x64.zip
+            dist/bgr_linux_x64.zip
+            dist/bgr_windows_x64.zip
diff --git a/README.md b/README.md
index bca113e..2156cfc 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,20 @@
+[![codecov](https://codecov.io/gh/StevanFreeborn/bgr/graph/badge.svg?token=5qp2LpvOZA)](https://codecov.io/gh/StevanFreeborn/bgr)
+
+[![Pull Request](https://github.com/StevanFreeborn/bgr/actions/workflows/pull_request.yml/badge.svg)](https://github.com/StevanFreeborn/bgr/actions/workflows/pull_request.yml)
+
+[![Publish](https://github.com/StevanFreeborn/bgr/actions/workflows/publish.yml/badge.svg)](https://github.com/StevanFreeborn/bgr/actions/workflows/publish.yml)
+
+![GitHub Release](https://img.shields.io/github/v/release/StevanFreeborn/bgr?display_name=tag)
+
+![GitHub License](https://img.shields.io/github/license/StevanFreeborn/bgr)
+
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+
+![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/StevanFreeborn/bgr/total)
+
 # BGR
 
-This is a background removal app that uses machine learning models to remove the background from an image. The app is available for download as a single file executable [here](). The app can also be built from source using the [.NET SDK](https://dotnet.microsoft.com/download). If you'd like to read more about the idea and initial development behind the app you can read the blog post I wrote about it [here]().
+This is a background removal app that uses machine learning models to remove the background from an image. The app is available for download [here](). You'll just need to unzip the files, place them in a directory, and it to your path. You can rename the executable to your preferred name. The app can also be built from source using the [.NET SDK](https://dotnet.microsoft.com/download). If you'd like to read more about the idea and initial development behind the app you can read the blog post I wrote about it [here](https://blog.stevanfreeborn.com/building-a-background-removal-app-with-machine-learning-and-dotnet).
 
 ## Usage