update README

.github/workflows/main.yml

@@ -50,17 +50,17 @@ jobs:
       - name: Checkout this Repo
         uses: actions/checkout@v2
 
-      # # print contents of GITHUB_WORKSPACE dir
-      # - name: verify contents
-      #   run: ls "${{ github.workspace }}"
-
       # Runs a this repo's action
       - name: Run Build action
         id: builder
         uses: 2bndy5/rmskin-action@master
         with:
           path: tests
 
+      # # print contents of GITHUB_WORKSPACE dir
+      # - name: verify contents
+      #   run: ls "${{ github.workspace }}"
+
       # Use the output from the `builder` step
       - name: Print the output filename
         run: echo "The output file was ${{ steps.builder.outputs.arc_name }}"

README.rst

@@ -1,15 +1,34 @@
 
 .. image:: https://github.com/2bndy5/rmskin-action/workflows/CI/badge.svg
     :target: https://github.com/2bndy5/rmskin-action/actions
+.. image:: https://img.shields.io/pypi/v/circuitpython-nrf24l01.svg
+    :target: https://pypi.python.org/pypi/circuitpython-nrf24l01
+    :alt: latest version on PyPI
 
 rmskin-action
 =============
 
-A Python-based Github action tool to package a Repository's Rainmeter Content into a validating .rmskin file for Rainmeter's Skin Installer.
+A Python-based Github action tool to package a Repository's Rainmeter Content into a validating
+.rmskin file for Rainmeter's Skin Installer.
 
 .. important::
-    If the repository contains a RMSKIN.bmp image to used as a header image in the rmskin package, then it must be using 24-bit colors.
-    Additionally, if the image is not exactly 400x60, then this action's python script will resize it accordingly.
+    If the repository contains a RMSKIN.bmp image to used as a header image in the rmskin package,
+    then it must be using 24-bit colors. Additionally, if the image is not exactly 400x60, then
+    this action's python script will resize it accordingly.
+
+rmskin-builder Python package
+-----------------------------
+
+This action's *rmskin-builder.py* is now also available as a Python executable script via PyPI.
+However, it is important that your Python installation's *Scripts* folder is found in your
+Operating System's environment variable ``PATH``. If you're using a Python virtual envirnment,
+then the *Scripts* folder does not need to be in your Operating System's environment variable
+``PATH``.
+
+.. code-block:: shell
+
+    pip install rmskin-builder
+    rmskin-builder.exe --help
 
 Input Arguments
 ===============
@@ -18,20 +37,31 @@ Input Arguments
     :header: "Argument", "Description", "Required"
     :widths: 5, 15, 3
 
-    "version", "Version of the Rainmeter rmskin package. Defaults to last 8 digits of SHA from commit or ref/tags", "no"
-    "title", "Name of the Rainmeter rmskin package. Defaults to name of repository", "no"
-    "author", "Account Username maintaining the rmskin package. Defaults to Username that owns the repository.", "no"
-    "path", "Base directory of repo being packaged. Defaults to workflow's workspace path", "no"
-    "dir_out", "Path to save generated rmskin package. Defaults to workflow's workspace path", "no"
+    "version", "Version of the Rainmeter rmskin package. Defaults to last 8 digits of SHA from commit or ref/tags or otherwise 'x0x.x0xy'.", "no"
+    "title", "Name of the Rainmeter rmskin package. Defaults to name of repository or otherwise the last directory in the ``path`` argument.", "no"
+    "author", "Account Username maintaining the rmskin package. Defaults to Username that triggered the action or otherwise 'Unknown'.", "no"
+    "path", "Base directory of repo being packaged. Defaults to current working path", "no"
+    "dir_out", "Path to save generated rmskin package. Defaults to current working path", "no"
 .. note::
     You can use your repository's ``RMSKIN.ini`` file to override any above inputs except ``dir_out`` & ``path`` inputs.
 
+The above arguments are used as CLI arguments to the *rmskin-builder.py* script, but remember to
+append the CLI arguments' name with a ``--``. For example, setting the ``path`` argument to use a
+relative directory called *tests*:
+
+.. code-block:: shell
+
+    rmskin-builder.py --path tests
+
 Output Arguments
 ================
 
 * ``arc_name`` : The name of the generated rmskin file saved in the
   path specified by ``dir_out`` input argument.
 
+If executing the *rmskin-builder.py* script when not in a Github Action Runner, then this output
+argument will show in the script's log output (& not saved anywhere).
+
 Ideal Repo Structure
 ====================
 
@@ -56,47 +86,29 @@ Example Usage
     name: RMSKIN Packager
 
     on:
-        push:
-        pull_request:
-        release:
-            types:
-                - published
+      push:
+      pull_request:
+      release:
+        types: [published]
 
     jobs:
-        Build_n_Release:
-            runs-on: ubuntu-latest
+      Build_n_Release:
+        runs-on: ubuntu-latest
 
         steps:
-            # Checkout code
-            - name: Checkout this Repo
-              uses: actions/checkout@v2
-
-            # Runs a rmskin packager action
-            - name: Run Build action
-              id: builder
-              uses: 2bndy5/[email protected]
-
-            # Use the output from the `builder` step
-            - name: Print the output filename
-              run: echo "The output file was ${{ steps.builder.outputs.arc_name }}"
-
-            # get release upload_url
-            - name: Get Release
-              id: get_release
-              uses: bruceadams/[email protected]
-              if: github.event_name == 'release'
-              env:
-                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-            # Upload the asset
-            - name: Upload Release Asset
-              id: upload-release-asset
-              uses: actions/upload-release-asset@v1
-              if: github.event_name == 'release'
-              env:
-                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-              with:
-                upload_url: ${{ steps.get_release.outputs.upload_url }}
-                asset_path: ./${{ steps.builder.outputs.arc_name }}
-                asset_name: ${{ steps.builder.outputs.arc_name }}
-                asset_content_type: application/zip
+          # Checkout code
+          - name: Checkout this Repo
+            uses: actions/checkout@v2
+
+          # Runs a rmskin packager action
+          - name: Run Build action
+            id: builder
+            uses: 2bndy5/[email protected]
+
+          # Upload the asset (using the output from the `builder` step)
+          - name: Upload Release Asset
+            if: github.event_name == 'release'
+            uses: csexton/release-asset-action@master
+            with:
+              file: "${{ steps.builder.outputs.arc_name }}"
+              github-token: ${{ secrets.GITHUB_TOKEN }}