From cde3d92acc22daac5ccf6d70663f14f804e702e8 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:27:46 +0200 Subject: [PATCH 1/2] Standardize README landing page --- README.md | 87 +++++++------------------------------------------------ 1 file changed, 11 insertions(+), 76 deletions(-) diff --git a/README.md b/README.md index 30be3fc..34c4f58 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,27 @@ -# TLS +# Tls -A PowerShell module that helps manage and configure TLS settings on your system. - -## Prerequisites - -This uses the following external resources: -- The [PSModule framework](https://github.com/PSModule) for building, testing and publishing the module. +Tls is a PowerShell module for working with TLS settings. ## Installation -To install the module from the PowerShell Gallery, you can use the following command: - -```powershell -Install-PSResource -Name TLS -Import-Module -Name TLS -``` - -## Usage - -Below are some typical use cases for the module's functions: - -### Example 1: Retrieve the Current TLS Configuration +Install the module from the PowerShell Gallery: ```powershell -Get-TLSConfig +Install-PSResource -Name Tls +Import-Module -Name Tls ``` -- Returns the TLS protocol(s) currently enabled for .NET applications on the system. - -### Example 2: List All Available TLS Protocols - -```powershell -Get-TLSConfig -ListAvailable -``` - -- Displays all TLS protocol types that can be potentially enabled. - -### Example 3: Enable TLS 1.2 - -```powershell -Set-TLSConfig -Protocol Tls12 -``` - -- Enables TLS 1.2 on the system without disabling previously enabled protocols. - -### Example 4: Enable Multiple TLS Protocols (e.g., TLS 1.2 and TLS 1.3) - -```powershell -Set-TLSConfig -Protocol Tls12, Tls13 -``` - -- Simultaneously enables TLS 1.2 and TLS 1.3. - -### Find more examples - -To find more examples of how to use the module, please refer to the [examples](examples) folder. - -Alternatively, you can run: -```powershell -Get-Command -Module TLS -``` -to see all available commands in the module. Then, for any command, you can do: -```powershell -Get-Help -Examples -``` -to view examples specific to that command. - ## Documentation -Additional documentation, if available, can be found in this repository. Check out the function-level help by running: +Documentation is published at [psmodule.io/Tls](https://psmodule.io/Tls/). + +Use PowerShell help and command discovery for module details: ```powershell -Get-Help Set-TLSConfig -Full -Get-Help Get-TLSConfig -Full +Get-Command -Module Tls +Get-Help -Examples ``` -This will show detailed usage information and parameter descriptions. - ## Contributing -Coder or not, you can contribute to the project! We welcome all contributions. - -### For Users - -If you don't code, you still have valuable insights. If you experience any unexpected behavior, see errors, or want additional functionality, please -submit a bug report or feature request via the Issues tab. - -### For Developers - -We’d love your help adding features, fixing bugs, and improving the module. Please read the [Contribution guidelines](CONTRIBUTING.md). You can pick -up an existing issue or submit a new one if you have ideas for improvements or new features. +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From 14a015a205b28ba455cc33b6abcb8741559ccd61 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:34:06 +0200 Subject: [PATCH 2/2] Address Copilot README review --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 34c4f58..7dd7e38 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# Tls +# TLS -Tls is a PowerShell module for working with TLS settings. +TLS is a PowerShell module for working with TLS settings. ## Installation Install the module from the PowerShell Gallery: ```powershell -Install-PSResource -Name Tls -Import-Module -Name Tls +Install-PSResource -Name TLS +Import-Module -Name TLS ``` ## Documentation -Documentation is published at [psmodule.io/Tls](https://psmodule.io/Tls/). +Documentation is published at [psmodule.io/TLS](https://psmodule.io/TLS/). Use PowerShell help and command discovery for module details: ```powershell -Get-Command -Module Tls -Get-Help -Examples +Get-Command -Module TLS +Get-Help Get-TLSConfig -Examples ``` ## Contributing