Skip to content

Commit b4acb3e

Browse files
committed
docs,README: update docs
To reflect changes in tool name from dotnet-fsharplint to fsharplint.
1 parent 7fc8646 commit b4acb3e

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The [docs](http://fsprojects.github.io/FSharpLint/) contain an overview of the t
3232

3333
Package | Version
3434
------- | --------
35-
[dotnet tool](https://www.nuget.org/packages/dotnet-fsharplint/) | [![NuGet Status](http://img.shields.io/nuget/v/dotnet-fsharplint.svg?style=flat)](https://www.nuget.org/packages/dotnet-fsharplint/)
35+
[dotnet tool](https://www.nuget.org/packages/fsharplint/) | [![NuGet Status](http://img.shields.io/nuget/v/fsharplint.svg?style=flat)](https://www.nuget.org/packages/fsharplint/)
3636
[API](https://www.nuget.org/packages/FSharpLint.Core/) | [![NuGet Status](http://img.shields.io/nuget/v/FSharpLint.Core.svg?style=flat)](https://www.nuget.org/packages/FSharpLint.Core/)
3737

3838
## How to build

docs/content/how-tos/install-dotnet-tool.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,24 @@ category: how-to
44
menu_order: 1
55
---
66

7-
# Installing as dotnet tool
7+
# Running fsharplint
8+
9+
The console application is a wrapper around the linter. For basic usage, just run `dnx fsharplint lint <input>`, where `input` can be an fsproj, sln, fs, fsx file, or a string of source code. This will install (if run for the first time) and run fsharplint.
10+
11+
Run `dnx fsharplint --help` for full usage information.
12+
13+
# Installing and runnnig on .NET versions before 10
14+
15+
## Installing as dotnet tool
816

917
The linter can be [installed as a dotnet tool](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install).
1018

11-
Install as a global tool: `dotnet tool install -g dotnet-fsharplint`.
19+
Install as a global tool: `dotnet tool install -g fsharplint`.
1220

13-
Install as tool to specific directory: `dotnet tool install --tool-path <my_directory> dotnet-fsharplint`
21+
Install as tool to specific directory: `dotnet tool install --tool-path <my_directory> fsharplint`
1422

1523
## Running the Console Application
1624

17-
The console application is a wrapper around the linter. For basic usage, just run `dotnet fsharplint lint <input>`, where `input` can be an fsproj, sln, fs, fsx file, or a string of source code.
25+
If installed as a local tool, run `dotnet fsharplint lint <input>`
1826

19-
Run `dotnet fsharplint --help` for full usage information.
27+
If installed as a global tool, run it as `fsharplint lint <input>`.

0 commit comments

Comments
 (0)