diff --git a/package.json b/package.json index 0af250d4ad..11fd31baf2 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ }, "channel": "stable", "license": "SEE LICENSE IN LICENSE", - "homepage": "https://github.com/microsoft/PSRule/blob/main/README.md", + "homepage": "https://aka.ms/ps-rule", "categories": [ "Programming Languages", "Snippets" diff --git a/src/vscode-ps-rule/README.md b/src/vscode-ps-rule/README.md index c0db0f16ab..5832288a0a 100644 --- a/src/vscode-ps-rule/README.md +++ b/src/vscode-ps-rule/README.md @@ -1,17 +1,8 @@ # PSRule -Validate infrastructure as code (IaC) and DevOps repositories using the PSRule PowerShell module. +Validate infrastructure as code (IaC) and DevOps repositories using the PSRule. PSRule is powerful, feature rich, and highly customizable to meet your needs. -![module-version-badge] - -This extension is available in two release channels: - -Channel | Description | Version/ downloads -------- | ----------- | --- -[Preview][ext-preview] | More frequent releases but more likely to contain bugs. | [![Preview][ext-preview-version-badge]][ext-preview] ![ext-preview-installs-badge] -[Stable][ext-stable] | Less frequent releases, with more user testing, experimental features are disabled. | [![Stable][ext-stable-version-badge]][ext-stable] ![ext-stable-installs-badge] - ## Features ### CodeLens @@ -92,67 +83,4 @@ Name | Description `PSRule.output.as` | Configures the output of analysis tasks, either summary or detailed. `PSRule.rule.baseline` | The name of the default baseline to use for executing rules. This setting can be overridden on individual PSRule tasks. -## Support - -This project uses GitHub Issues to track bugs and feature requests. -Please search the existing issues before filing new issues to avoid duplicates. - -- For new issues, file your bug or feature request as a new [issue]. -- For help, discussion, and support questions about using this project, join or start a [discussion]. - -Support for this project/ product is limited to the resources listed above. - -## Installing PSRule module - -PSRule is available from the PowerShell Gallery and is required for this extension to work. - -To install the module use the following command from a PowerShell prompt. - -```powershell -Install-Module -Name PSRule -Scope CurrentUser; -``` - -## Installing the extension - -You can install the latest release of the extension by following the steps in the [Visual Studio Code documentation][vscode-ext-gallery]. -In the Extensions pane, search for _PSRule_ extension and install it there. -You will get notified automatically about any future extension updates. - -```text -code --install-extension bewhite.psrule-vscode-preview -``` - -> NOTE: If you are using VS Code Insiders, the command will be `code-insiders`. - -## Contributing - -This project welcomes contributions and suggestions. -If you are ready to contribute, please visit the [contribution guide]. - -## Code of Conduct - -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) -or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. - -## Maintainers - -- [Bernie White](https://github.com/BernieWhite) - -## License - -This project is [licensed under the MIT License][license]. - -[issue]: https://github.com/Microsoft/PSRule/issues -[discussion]: https://github.com/microsoft/PSRule/discussions -[vscode-ext-gallery]: https://code.visualstudio.com/docs/editor/extension-gallery -[ext-preview]: https://marketplace.visualstudio.com/items?itemName=bewhite.psrule-vscode-preview -[ext-preview-version-badge]: https://img.shields.io/visual-studio-marketplace/v/bewhite.psrule-vscode-preview?label=Version -[ext-preview-installs-badge]: https://img.shields.io/visual-studio-marketplace/i/bewhite.psrule-vscode-preview?label=Installs -[ext-stable]: https://marketplace.visualstudio.com/items?itemName=bewhite.psrule-vscode -[ext-stable-version-badge]: https://img.shields.io/visual-studio-marketplace/v/bewhite.psrule-vscode?label=Version -[ext-stable-installs-badge]: https://img.shields.io/visual-studio-marketplace/i/bewhite.psrule-vscode?label=Installs -[module-version-badge]: https://img.shields.io/powershellgallery/v/PSRule?label=PowerShell%20Gallery -[contribution guide]: https://github.com/Microsoft/PSRule/blob/main/CONTRIBUTING.md -[license]: https://github.com/Microsoft/PSRule/blob/main/LICENSE [ps-rule.yaml]: https://aka.ms/ps-rule/options