Skip to content

Commit 3e755dd

Browse files
committed
Update README
1 parent 2af473a commit 3e755dd

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,36 @@ PSAppDeployToolkit.Tools is a companion module for [PSAppDeployToolkit](https://
66

77
### Features
88

9-
- Test your PSAppDeployToolkit v3 scripts to get a full report on which functions and variables have changed in v4.
10-
- Convert a PSAppDeployToolkit v3 script or an entire package folder to v4 standards.
9+
- **Test-ADTCompatibility** - Test your PSAppDeployToolkit v3 scripts to get a full report on which functions and variables have changed in v4.
10+
- **Convert-ADTDeployment** - Convert a PSAppDeployToolkit v3 script or an entire package folder to v4 standards.
1111

1212
## Getting Started
1313

14-
-> [System Requirements](https://psappdeploytoolkit.com/docs/getting-started/requirements)
15-
-> [Downloading](https://psappdeploytoolkit.com/docs/getting-started/download)
14+
Install the module from the PowerShell Gallery:
15+
16+
```powershell
17+
Install-Module PSAppDeployToolkit.Tools -Scope CurrentUser
18+
```
19+
20+
Example command usage:
21+
22+
```powershell
23+
Test-ADTCompatibility -FilePath .\Deploy-Application.ps1 -Format Grid
24+
```
25+
26+
This example analyzes Deploy-Application.ps1 and outputs the results as a grid view.
27+
28+
```powershell
29+
Convert-ADTDeployment -Path .\Deploy-Application.ps1
30+
```
31+
32+
This example converts Deploy-Application.ps1 into Invoke-AppDeployToolkit.ps1 in the same folder.
33+
34+
```powershell
35+
Convert-ADTDeployment -Path .\PackageFolder
36+
```
37+
38+
This example converts PackageFolder into PackageFolder_Converted in the same folder.
1639

1740
### PSAppDeployToolkit Links
1841

0 commit comments

Comments
 (0)