Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
(cherry picked from commit 05455a680e6874bacf38a945abaca92865a1e2d3)
  • Loading branch information
Mpdreamz committed Jul 14, 2020
1 parent 4535667 commit 41c38e6
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,19 @@ The EditorConfig .NET core provides the same functionality as the

## Installation

The library exists on nuget under
The library exists on nuget as:

```
nuget install editorconfig
```

The commandline tooling is uploaded to chocolatey under
The .NET core tool exists under:

```
cinst editorconfig.core
dotnet tool install editorconfig-tool
```


## Usage

Usage as a library:
Expand All @@ -32,8 +33,10 @@ foreach (var kv in configuration.Properties)

Usage as a command line tool:

You can omit `dotnet` if you install this as a global tool

```
> editorconfig.exe
> dotnet editorconfig-tool
Usage: editorconfig [OPTIONS] FILEPATH1 [FILEPATH2 FILEPATH3 ...]
Expand All @@ -51,7 +54,7 @@ Usage as a command line tool:

Example:

> editorconfig.exe C:\Users\zoidberg\Documents\anatomy.md
> dotnet editorconfig-tool C:\Users\zoidberg\Documents\anatomy.md
charset=utf-8
insert_final_newline=true
end_of_line=lf
Expand Down

0 comments on commit 41c38e6

Please sign in to comment.