Merge pull request #13 from theohbrothers/docs/readme-add-development…

…-section Docs (readme): Add Development section
theohbrothers · Oct 30, 2022 · dcb5133 · dcb5133
2 parents b343ba6 + 300f349
commit dcb5133
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -38,3 +38,17 @@ An example `docker-compose.yml` is included demonstrating how to use this image
 Q: Why is there no alpine image?
 
 - At the present moment, alpine is not yet supported by the [Varnish Agent](https://github.com/varnish/vagent2)
+
+## Development
+
+Requires Windows `powershell` or [`pwsh`](https://github.com/PowerShell/PowerShell).
+
+```powershell
+# Install Generate-DockerImageVariants module: https://github.com/theohbrothers/Generate-DockerImageVariants
+Install-Module -Name Generate-DockerImageVariants -Repository PSGallery -Scope CurrentUser -Force -Verbose
+
+# Edit ./generate templates
+
+# Generate the variants
+Generate-DockerImageVariants .
+```
diff --git a/generate/README.md b/generate/README.md
diff --git a/generate/templates/README.md.ps1 b/generate/templates/README.md.ps1
@@ -26,8 +26,10 @@ $(
     }
 }) -join ''
 )
-"@ + @'
 
+"@
+
+@'
 ## Usage
 
 An example `docker-compose.yml` is included demonstrating how to use this image with an separate Varnish image (e.g. [`varnish-alpine-docker`](https://github.com/thiagofigueiro/varnish-alpine-docker)).
@@ -55,4 +57,18 @@ Q: Why is there no alpine image?
 
 - At the present moment, alpine is not yet supported by the [Varnish Agent](https://github.com/varnish/vagent2)
 
+## Development
+
+Requires Windows `powershell` or [`pwsh`](https://github.com/PowerShell/PowerShell).
+
+```powershell
+# Install Generate-DockerImageVariants module: https://github.com/theohbrothers/Generate-DockerImageVariants
+Install-Module -Name Generate-DockerImageVariants -Repository PSGallery -Scope CurrentUser -Force -Verbose
+
+# Edit ./generate templates
+
+# Generate the variants
+Generate-DockerImageVariants .
+```
+
 '@