Skip to content

Commit a95ce24

Browse files
authored
Update README.MD
1 parent da8c72d commit a95ce24

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.MD

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,26 @@ The bit.ly link will always point to the latest release of ModuleFast by default
4141
& ([scriptblock]::Create((iwr 'bit.ly/modulefast'))) -Release 'v0.2.0' -Specification ImportExcel
4242
```
4343

44+
### Module Specification Syntax
45+
46+
ModuleFast introduces a shorthand string syntax for defining module specifications. It generally takes the form of '<Module><Operator><Version>'. The version supports SemVer 2 and prerelease tags.
47+
48+
The available operators are:
49+
- '=': Exact version match. Examples: 'ImportExcel=7.1.0', 'ImportExcel=7.1.0-preview'
50+
- '>': Greater than. Example: 'ImportExcel>7.1.0'
51+
- '>=': Greater than or equal to. Example: 'ImportExcel>=7.1.0'
52+
- '<': Less than. Example: 'ImportExcel<7.1.0'
53+
- '<=': Less than or equal to. Example: 'ImportExcel<=7.1.0'
54+
- '!': A prerelease operator that can be present at the beginning or end of a module name to indicate that prerelease versions are acceptable. Example: 'ImportExcel!', '!ImportExcel'. It can be combined with the other operators like so: 'ImportExcel!>7.1.0'
55+
- ':': Lets you specify a NuGet version range. Example: 'ImportExcel:(7.0.0, 7.2.1-preview]'
56+
57+
For more information about NuGet version range syntax used with the ':' operator: https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges. Wilcards are supported with this syntax e.g. 'ImportExcel:3.2.*' will install the latest 3.2.x version.
58+
59+
ModuleFast also fully supports the ModuleSpecification object and hashtable-like string syntaxes that are used by Install-Module and Install-PSResource. More information on this format: https://learn.microsoft.com/en-us/dotnet/api/microsoft.powershell.commands.modulespecification?view=powershellsdk-7.4.0
60+
61+
### Logging
62+
Modulefast has extensive Verbose and Debug information available if you specify the -Verbose and/or -Debug parameters. This can be useful for troubleshooting or understanding how ModuleFast is working. Verbose level provides a high level "what" view of the process of module selection, while Debug level provides a much more detailed "Why" information about the module selection and installation process that can be useful in troubleshooting issues.
63+
4464
### ![alt text](images/README/image.png) GitHub Action
4565

4666
ModuleFast provides a [GitHub Action](https://github.com/marketplace/actions/modulefast). Details for usage are on the GitHub Marketplace page.

0 commit comments

Comments
 (0)