Skip to content

Commit 7c2afef

Browse files
committed
update readme
1 parent c2de984 commit 7c2afef

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

Src/CSharpier.VSCode/CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 2.0.8
2+
- Update readme
3+
14
## 2.0.7
25
- Ensure extension works with windows virtual drives
36

Src/CSharpier.VSCode/README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# CSharpier Formatter for Visual Studio Code
22

3-
This extension makes use of the dotnet tool [CSharpier](https://github.com/belav/csharpier) to format your code and is versioned independently.
3+
This extension makes use of the dotnet tool [CSharpier](https://github.com/belav/csharpier) to format your code. This extension is versioned independently from CSharpier itself.
44

55
CSharpier is an opinionated code formatter for c# and xml. \
6-
It provides very few options and provides a deterministic way to enforce formatting of your code. \
7-
The printing process was ported from [prettier](https://prettier.io) but has evolved over time. \
6+
It provides very few options and a deterministic way to enforce formatting of your code. \
7+
The printing process was ported from [prettier](https://prettier.io) but has evolved over time.
88

99
## Installation
1010

@@ -32,6 +32,8 @@ The extension makes use of `dotnet` commands and uses the following logic to loc
3232
## Default Formatter
3333
To ensure that CSharpier is used to format files, be sure to set it as the default formatter.
3434

35+
You can modify your [settings.json](https://code.visualstudio.com/docs/configure/settings#_settings-json-file) file.
36+
3537
```json
3638
"[csharp]": {
3739
"editor.defaultFormatter": "csharpier.csharpier-vscode"
@@ -41,6 +43,10 @@ To ensure that CSharpier is used to format files, be sure to set it as the defau
4143
},
4244
```
4345

46+
## Troubleshooting
47+
48+
See [this page](https://csharpier.com/docs/EditorsTroubleshooting)
49+
4450
## Usage
4551

4652
### Keyboard Shortcuts

Src/CSharpier.VSCode/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "csharpier-vscode",
33
"displayName": "CSharpier - Code formatter",
44
"description": "Code formatter using csharpier",
5-
"version": "2.0.7",
5+
"version": "2.0.8",
66
"publisher": "csharpier",
77
"author": "CSharpier",
88
"homepage": "https://marketplace.visualstudio.com/items?itemName=csharpier.csharpier-vscode",

0 commit comments

Comments
 (0)