From b9e35f3311e2cdf295c5160e2be7df447bf418e3 Mon Sep 17 00:00:00 2001
From: Noel Miller <noelmiller@protonmail.com>
Date: Wed, 6 Mar 2024 15:05:43 -0600
Subject: [PATCH] fix: added output information to README

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index b1c7ad1..2dff8a7 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,26 @@ This action is designed to be called from a GitHub workflow using the following
 ```yaml
 - name: Build ISO
   uses: jasonn3/build-container-installer/v1.0.0
+  id: build
   with:
     arch: ${{ env.ARCH}}
     image_name: ${{ env.IMAGE_NAME}}
     image_repo: ${{ env.IMAGE_REPO}}
     version: ${{ env.VERSION }}
     variant: ${{ env.VARIANT }}
+
+# This example is for uploading your ISO as a Github artifact. You can do something similar using any cloud storage, so long as you copy the output
+- name: Upload ISO as artifact
+  id: upload
+  uses: actions/upload-artifact@v4
+  with:
+    name: my_iso.iso
+    path: |
+      ${{ steps.build.outputs.iso_path }}
+      ${{ steps.build.outputs.checksum-path }}
+  if-no-files-found: error
+  retention-days: 0
+  compression-level: 0
 ```
 
 See [Customizing](#customizing) for information about customizing the ISO that gets created using `with`
@@ -21,6 +35,7 @@ See [Customizing](#customizing) for information about customizing the ISO that g
 ## Customizing
 The following variables can be used to customize the created ISO.
 
+### Inputs
 | Variable          | Description                                              | Default Value                  |
 | ----------------- | -------------------------------------------------------- | ------------------------------ |
 | ARCH              | Architecture for image to build                          | x86_64                         |
@@ -36,6 +51,14 @@ The following variables can be used to customize the created ISO.
 Available options for VARIANT can be found by running `dnf provides system-release`. 
 Variant will be the third item in the package name. Example: `fedora-release-kinoite-39-34.noarch` will be kinoite
 
+### Outputs
+| Variable          | Description                                              | Usage                                            |
+| ----------------- | -------------------------------------------------------- | ------------------------------------------------ |
+| iso-path          | Path to ISO file that the action creates                 | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_path }} |
+| checksum-path     | Path to the checksum file that the action creates        | ${{ steps.YOUR_ID_FOR_ACTION.outputs.iso_path }} |
+
+For outputs, see example above.
+
 ## Development
 ### Makefile
 The Makefile contains all of the commands that are run in the action. There are separate targets for each file generated, however `make` can be used to generate the final image and `make clean` can be used to clean up the workspace. The resulting ISO will be stored in the `build` directory.