diff --git a/README.md b/README.md index f7e07f4..5e66ca2 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,22 @@ It includes a command-line shell, an associated scripting language and a framewo Windows PowerShell is a Windows command-line shell designed especially for system administrators. Windows PowerShell includes an interactive prompt and a scripting environment that can be used independently or in combination. -The PowerShell Standard has been created to assist developers create modules and PowerShell hosts which will use only APIs that exist across different versions of PowerShell. +PowerShell Standard is a reference assembly that has been created to assist developers create modules and PowerShell hosts which will run on PowerShell. +The reference assembly contains no actual implementation but rather will allow you to use only APIs that exist across different versions of PowerShell. This means that you still need to run within a PowerShell runtime. + +> NOTE: You should not use PowerShell Standard for standalone applications that leverage PowerShell. +For that, you should use the [PowerShell SDK](https://www.nuget.org/packages/Microsoft.PowerShell.SDK). +PowerShell Standard's main scenario is for running within a PowerShell session. ## PowerShell Standard Libraries Two PowerShell Standard `.nupkg` versions are available: - PowerShell Standard.Library Version 3 - - This allows you to create PowerShell modules and host which will run on PowerShell Version 3 and later including PowerShellCore + - This allows you to create PowerShell modules and PowerShell hosts which will run on PowerShell Version 3 and later including PowerShellCore - PowerShell Standard.Library Version 5.1 - - This allows you to create PowerShell modules and host which will run on PowerShell Version 5.1 and later including PowerShellCore + - This allows you to create PowerShell modules and PowerShell hosts which will run on PowerShell Version 5.1 and later including PowerShellCore Both are available on [NuGet.org](https://www.nuget.org/packages/PowerShellStandard.Library)