allow readme to be skipped, update readme

Author: tedivm

action.yml

@@ -50,6 +50,11 @@ inputs:
     required: true
     default: ''
 
+  skip_readme:
+    description: 'When set to true the readme fill will not be generated.'
+    required: true
+    default: 'false'
+
   include_prereleases:
     description: 'If set to true prereleases (alpha, beta, rc) will also be built.'
     required: true
@@ -97,6 +102,7 @@ runs:
         INCLUDE_PRERELEASE: ${{ inputs.include_prereleases }}
         BUILDER_WORKFLOW_PATH: ${{ inputs.action_path }}
         EXCLUDE_VERSIONS: ${{ inputs.exclude_versions }}
+        SKIP_README:  ${{ inputs.skip_readme }}
 
     - name: "Push"
       shell: bash

scripts/update_readme.sh

@@ -1,4 +1,10 @@
 #!/usr/bin/env bash
+
+if [[ $SKIP_README == "true" ]]; then
+  echo "Generation of README.md is disabled."
+  exit 0
+fi
+
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 export PACKAGE_VERSIONS=$($SCRIPT_DIR/latest_versions.py $PACKAGE ${MAX_VERSIONS:-10})
 

templates/README.md

@@ -3,6 +3,32 @@
 
 {{ description }}
 
+## Benefits
+
+### Multi Architecture Builds
+
+Every tag in this repository supports these architectures:
+
+{% for platform in platforms -%}
+* {{ platform }}
+{% endfor %}
+
+### Small Images via Multi Stage Builds
+
+All libraries are compiled in one image before being moved into the final published image. This keeps all of the build tools out of the published container layers.
+
+### No Rate Limits
+
+This project uses the Github Container Registry to store images, which have no rate limiting on pulls (unlike Docker Hub).
+
+### Rapid Building of New Versions
+
+Within 30 minutes of a new release to {{ package }} on PyPI builds will kick off for new containers. This means new versions can be used in hours, not days.
+
+### Regular Updates
+
+Containers are rebuilt weekly in order to take on the security patches from upstream containers.
+
 {{ quick_start }}
 
 ## Python Versions