Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
* Fix NuGet package name
* Include description of SemVer 2 limitations and workarounds
  • Loading branch information
sharwell committed Sep 20, 2018
1 parent 059d451 commit e207257
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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)
Expand All @@ -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.
Expand Down

0 comments on commit e207257

Please sign in to comment.