docs: improve readme

Greenroom-Robotics · Jun 8, 2022 · 188f617 · 188f617
1 parent 5a322d1
commit 188f617
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,13 +21,13 @@ jobs:
 
       - uses: actions/checkout@v2
 
-      - name: Bump version
+      - name: Build Docker Image and Tag
         run: |
           docker build . -t nuclio_lighting_flash
           docker tag nuclio_lighting_flash ghcr.io/greenroom-robotics/nuclio_lighting_flash:latest
           docker tag nuclio_lighting_flash ghcr.io/greenroom-robotics/nuclio_lighting_flash:${{github.event.inputs.TAG_NAME}}
-          docker push nuclio_lighting_flash ghcr.io/greenroom-robotics/nuclio_lighting_flash:latest
-          docker push nuclio_lighting_flash ghcr.io/greenroom-robotics/nuclio_lighting_flash:${{github.event.inputs.TAG_NAME}}
+          docker push ghcr.io/greenroom-robotics/nuclio_lighting_flash:latest
+          docker push ghcr.io/greenroom-robotics/nuclio_lighting_flash:${{github.event.inputs.TAG_NAME}}
 
       - name: Create a release
         uses: softprops/action-gh-release@v1

diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # Nuclio Lighting Flash
 
-This repo builds a base image "GreenroomRobotics/nuclio_lighting_flash" which can be used to run flash ObjectDetection models in Nuclio / CVAT
-
+This repo builds a base image [ghcr.io/greenroom-robotics/nuclio_lighting_flash:latest](ghcr.io/greenroom-robotics/nuclio_lighting_flash:latest) which is used to conveniently run flash ObjectDetection models in Nuclio / CVAT. It allows you to configure the model `head`, `backbone` and `checkpoint_path` from your nuclio `function.yml`
 
 ## Usage