Skip to content

Commit 517a81b

Browse files
Standardize README landing page
1 parent 9614ce6 commit 517a81b

1 file changed

Lines changed: 15 additions & 58 deletions

File tree

README.md

Lines changed: 15 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,27 @@
1-
![AzureDevOps icon](./Assets/azuredevops.png)
2-
31
# AzureDevOps
42

5-
[![Build Status](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_apis/build/status/azuredevops-powershell-ci)](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_build/latest?definitionId=1)
6-
[![Azure DevOps Tests](https://img.shields.io/azure-devops/tests/azuredevops-powershell/azuredevops-powershell/1.svg?logo=azuredevops)](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_build/latest?definitionId=1)
7-
[![Azure DevOps Coverage](https://img.shields.io/azure-devops/coverage/azuredevops-powershell/azuredevops-powershell/1.svg?logo=azuredevops)](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_build/latest?definitionId=1)
8-
[![Azure DevOps Release - PowerShell Gallery](https://vsrm.dev.azure.com/azuredevops-powershell/_apis/public/Release/badge/4d81da9c-b02f-4f9a-8775-c8444d950246/1/1)](https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_release/)
9-
[![AzureDevOps PSGallery version](https://img.shields.io/powershellgallery/v/AzureDevOps.svg)](https://www.powershellgallery.com/packages/AzureDevOps)
10-
[![AzureDevOps PSGallery downloads](https://img.shields.io/powershellgallery/dt/AzureDevOps.svg?logo=powershell)](https://www.powershellgallery.com/packages/AzureDevOps)
11-
12-
AzureDevOps is a very simple (and primitive) PowerShell module to interact with the Azure DevOps REST API.
13-
14-
## Getting started
15-
16-
1. Install the module
17-
18-
```powershell
19-
Install-Module AzureDevOps
20-
```
21-
22-
2. Import the module
23-
24-
```powershell
25-
Import-Module AzureDevOps
26-
```
27-
28-
3. Add connection details
29-
30-
```powershell
31-
# Add Azure DevOps connection details
32-
Add-AzureDevOpsAccount `
33-
-OrganisationName "contoso" `
34-
-ProjectName "AzureDevOps PowerShell Demo" `
35-
-UserName "user@name.com" `
36-
-Token "<azure-devops-personal-access-token>";
37-
```
38-
39-
4. Check out the examples in the [Examples](https://github.com/mehmetseckin/azuredevops-powershell/tree/master/Examples) folder.
40-
41-
5. Or, check out the list of available cmdlets
3+
AzureDevOps is a PowerShell module for interacting with the Azure DevOps REST API.
424

43-
```powershell
44-
Get-Command *AzureDevOps*
45-
```
5+
## Installation
466

47-
6. Use `Get-Help` to see details for the cmdlets.
7+
Install the module from the PowerShell Gallery:
488

49-
```powershell
50-
Get-Help Add-AzureDevOpsAccount -Detailed
51-
```
9+
```powershell
10+
Install-PSResource -Name AzureDevOps
11+
Import-Module -Name AzureDevOps
12+
```
5213

5314
## Documentation
5415

55-
Documentation for the individual commands is available in the [Docs](https://github.com/mehmetseckin/azuredevops-powershell/blob/master/Docs/AzureDevOps.md) folder.
16+
Documentation is published at [psmodule.io/AzureDevOps](https://psmodule.io/AzureDevOps/).
5617

57-
## References
18+
Use PowerShell help and command discovery for module details:
5819

59-
- [Azure DevOps CLI](https://learn.microsoft.com/en-us/azure/devops/cli/?view=azure-devops)
60-
- [Azure DevOps Services REST API Reference](https://learn.microsoft.com/en-us/rest/api/azure/devops/)
61-
- [Azure DevOps Developer resources documentation | Microsoft Learn](https://learn.microsoft.com/en-us/azure/devops/dev-resources/?view=azure-devops)
62-
- [How to use the Azure DevOps REST API with PowerShell | YouTube](https://www.youtube.com/watch?v=ylJmee-4KTo)
20+
```powershell
21+
Get-Command -Module AzureDevOps
22+
Get-Help <CommandName> -Examples
23+
```
6324

64-
## Similar projects
25+
## Contributing
6526

66-
* [vsteam](https://github.com/DarqueWarrior/vsteam) - A comprehensive PowerShell module for accessing TFS and VSTS.
67-
* [AzureDevOpsPowerShell](https://github.com/rfennell/AzureDevOpsPowershell) - A selection of PowerShell scripts that make use of the Azure DevOps (TFS/VSTS) APIs.
68-
* [vststools-cli](https://github.com/AssureCare/vststools-cli) - A set of useful command-line tools and extensions for VSTS.
69-
* [AzurePipelinesPS](https://github.com/Dejulia489/AzurePipelinesPS) - A PowerShell module that makes interfacing with Azure Pipelines a little easier
70-
* [AZDOPS](https://github.com/AZDOPS/AZDOPS)
27+
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.

0 commit comments

Comments
 (0)