Skip to content

Commit 2e46a5d

Browse files
committed
Add documentation for new cmdlets
1 parent 262ae38 commit 2e46a5d

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ You can install this module using PowerShellGet.
3030
Install-Module -Name ALZ
3131
```
3232

33-
### Quick start
34-
3533
Before you start you can utilize the functionality of the module to verify if you have all the prerequisites installed with the built in command:
3634

3735
```powershell
@@ -52,6 +50,16 @@ Currently this tests for:
5250
New-ALZEnvironment -o <output_directory>
5351
```
5452

53+
## Additonal Cmdlets
54+
55+
### Update an existing Azure Landing Zone Environment
56+
57+
#### Downloads and pulls down release version from the remote GitHub repository to a local directory
58+
59+
```powershell
60+
Get-ALZGithubRelease -githubRepoUrl "https://github.com/Azure/ALZ-Bicep" -releases "v0.13.0" -directoryForReleases "C:\Repos\ALZ\accelerator\upstream-releases\"
61+
```
62+
5563
## Development
5664

5765
### Development Prerequisites
@@ -69,7 +77,7 @@ Import-Module .\src\Artifacts\ALZ.psd1 -Force
6977
## Contributing
7078

7179
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
72-
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
80+
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
7381

7482
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
7583

0 commit comments

Comments
 (0)