diff --git a/README.md b/README.md index a7135c0..0486ce5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@

- - + + AsBuiltReport.System.Resources

- + - + - +

@@ -17,11 +17,7 @@ - -

-

- - +

@@ -29,8 +25,6 @@

-# System Resources As Built Report - > [!IMPORTANT] > The intention of this report is to ilustrate the capabilities of the AsBuiltReport project. This report is not intended to be used for production environments and should only be used for testing and demonstration purposes. @@ -40,13 +34,13 @@ System Resources As Built Report is a PowerShell module which works in conjuncti Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for more detailed information about this project. -## :books: Sample Reports +## Sample Reports Sample System Resources As Built report HTML file: [Sample System Resources As-Built Report.html](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.System.Resources/dev/Samples/System%20Resources%20As%20Built%20Report.html) -# :beginner: Getting Started +# Getting Started Below are the instructions on how to install, configure and generate a System Resources As Built report. -## :floppy_disk: Supported Versions +## Supported Versions The System Resources As Built Report supports the following Resources versions; @@ -58,7 +52,7 @@ This report is compatible with the following PowerShell versions; | :--------------------: | :----------------: | | :white_check_mark: | :white_check_mark: | -## 🗺️ Language Support +## Language Support ### Supported Languages - English (US) (Default) - English (GB) @@ -88,7 +82,7 @@ This report is compatible with the following PowerShell versions; - Turkish (TR) - Vietnamese (VN) -## :wrench: System Requirements +## System Requirements PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a System Resources As Built Report. @@ -99,11 +93,11 @@ PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are require > [!IMPORTANT] > This report requires AsBuiltReport.Core version 1.5.0 or later to be installed. [Multilingual-support](https://www.asbuiltreport.com/blog/2025/09/05/Multilingual-support/) -### :closed_lock_with_key: Required Privileges +### Required Privileges Local user privileges are required to run this report. -## :package: Module Installation +## Module Installation ### PowerShell @@ -129,7 +123,7 @@ If you are unable to use the PowerShell Gallery, you can still install the modul _Note: You are not limited to installing the module to those example paths, you can add a new entry to the environment variable PSModulePath if you want to use another path._ -## :pencil2: Configuration +## Configuration The System Resources As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks. @@ -206,7 +200,7 @@ The **Healthcheck** schema is used to toggle health checks on or off. No health checks are currently available for this report. -## :computer: Examples +## Examples The following examples demonstrate how to generate a System Resources As Built Report.