Skip to content

Apply the AsBuiltReport brand to the README - #17

Merged
tpcarman merged 1 commit into
devfrom
feature/readme-brand
Nov 14, 2026
Merged

tpcarman merged 1 commit into
devfrom
feature/readme-brand

Conversation

@tpcarman

Copy link
Copy Markdown
Contributor

Summary

Applies the AsBuiltReport brand to the README, to match www.asbuiltreport.com and the other report modules:

  • Banner: the repo banner in place of the small organisation logo. Its last line shows PS> Install-Module AsBuiltReport.System.Resources once the module is on the PowerShell Gallery, and the GitHub address until then.
  • Section icons: the emoji on the section headings are replaced with the section icon pack, in the style of the feature icons on the website.
  • Badges: recoloured to the brand palette: link blue #1F5FD0 for versions, console blue #012456 for counts, highlighter #FFD02B for compatibility.
  • Highlight swatches (where the README has a HealthCheck table): the colour images now come from the central swatches instead of placeholder services such as placehold.co, which break. Each swatch shows the colour this module's report style uses, so it can differ from the old image where that showed another module's colour.
  • Title heading: removed (for example # VMware vSphere As Built Report), because the banner already names the repo.
  • X follow badge: the follow @AsBuiltReport badge is removed.

The banner, icons and swatches are rendered by the generator in the .github repo, which keeps them up to date, so this repo does not store the images. Only README.md changes.

🤖 Generated with Claude Code

- Repo banner in place of the organisation logo
- Section icons in place of emoji on the section headings
- Badges in the brand palette: link blue for versions, console blue for counts, highlighter for compatibility
- Central health check highlight swatches in place of placeholder image services, in the report style's colours
- Title heading removed, as the banner names the repo
- X (Twitter) follow @AsBuiltReport badge removed

The banner, icons and swatches are rendered centrally by the generator in the .github repo.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

PSScriptAnalyzer results:

Errors: [0], Warnings: [26], Information: [1]


RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSUseBOMForUnicodeEncodedFile
Severity   : Warning
ScriptName : SystemResources.psd1
Line       : 
Message    : Missing BOM encoding for non-ASCII encoded file 
             'SystemResources.psd1'

RuleName   : PSAvoidTrailingWhitespace
Severity   : Information
ScriptName : SystemResources.psd1
Line       : 35
Message    : Line has trailing whitespace

@tpcarman
tpcarman merged commit 6938123 into dev Nov 14, 2026
2 checks passed
@tpcarman
tpcarman deleted the feature/readme-brand branch November 14, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant