From e20725793776500067a591c8b5ad49036eb51592 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Thu, 20 Sep 2018 09:21:51 -0500 Subject: [PATCH] Update README * Fix NuGet package name * Include description of SemVer 2 limitations and workarounds --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5256c1..f56404e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Documentation Analyzers for the .NET Compiler Platform +# Documentation Analyzers for the .NET Compiler Platform [![NuGet](https://img.shields.io/nuget/v/DotNetAnalyzers.DocumentationAnalyzers.svg)](https://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers) [![NuGet Beta](https://img.shields.io/nuget/vpre/DotNetAnalyzers.DocumentationAnalyzers.svg)](https://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers) @@ -12,7 +12,7 @@ This repository contains an implementation of .NET documentation rules using the ## Using DocumentationAnalyzers -The preferable way to use the analyzers is to add the nuget package [DocumentationAnalyzers](http://www.nuget.org/packages/DocumentationAnalyzers/) +The preferable way to use the analyzers is to add the nuget package [DotNetAnalyzers.DocumentationAnalyzers](http://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers/) to the project where you want to enforce documentation rules. The severity of individual rules may be configured using [rule set files](https://docs.microsoft.com/en-us/visualstudio/code-quality/using-rule-sets-to-group-code-analysis-rules) @@ -25,10 +25,13 @@ For documentation and reasoning on the rules themselves, see the [DOCUMENTATION. DocumentationAnalyzers can be installed using the NuGet command line or the NuGet Package Manager in Visual Studio 2015. **Install using the command line:** -```bash -Install-Package DocumentationAnalyzers + +```ps +Install-Package DotNetAnalyzers.DocumentationAnalyzers ``` +> ⚠ Prereleases of the **DotNetAnalyzers.DocumentationAnalyzers** package use Semantic Versioning 2, which requires NuGet 4.3.0 (Visual Studio 2017 version 15.3) or newer. Users with clients that do not support Semantic Versioning 2 may install prereleases using the **DotNetAnalyzers.DocumentationAnalyzers.Unstable** package instead. + ## Team Considerations If you use older versions of Visual Studio in addition to Visual Studio 2015 or Visual Studio 2017, you may still install these analyzers. They will be automatically disabled when you open the project back up in Visual Studio 2013 or earlier.