Skip to content

Commit 1b61531

Browse files
authored
Merge pull request #48 from sharwell/update-readme
Update README
2 parents bdf9932 + e207257 commit 1b61531

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Documentation Analyzers for the .NET Compiler Platform
1+
# Documentation Analyzers for the .NET Compiler Platform
22

33
[![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)
44

@@ -12,7 +12,7 @@ This repository contains an implementation of .NET documentation rules using the
1212

1313
## Using DocumentationAnalyzers
1414

15-
The preferable way to use the analyzers is to add the nuget package [DocumentationAnalyzers](http://www.nuget.org/packages/DocumentationAnalyzers/)
15+
The preferable way to use the analyzers is to add the nuget package [DotNetAnalyzers.DocumentationAnalyzers](http://www.nuget.org/packages/DotNetAnalyzers.DocumentationAnalyzers/)
1616
to the project where you want to enforce documentation rules.
1717

1818
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.
2525
DocumentationAnalyzers can be installed using the NuGet command line or the NuGet Package Manager in Visual Studio 2015.
2626

2727
**Install using the command line:**
28-
```bash
29-
Install-Package DocumentationAnalyzers
28+
29+
```ps
30+
Install-Package DotNetAnalyzers.DocumentationAnalyzers
3031
```
3132

33+
> ⚠ 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.
34+
3235
## Team Considerations
3336

3437
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.

0 commit comments

Comments
 (0)