Skip to content

Commit 6859b56

Browse files
committed
docs: update readme
1 parent 09092d9 commit 6859b56

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

.changeset/tough-buses-share.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"phpstan-vscode": patch
3+
---
4+
5+
Update the readme file

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
# phpstan-vscode
22

3-
![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/swordev.phpstan)
4-
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/swordev/phpstan-vscode/CI)
5-
![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/swordev.phpstan)
3+
[![version]](https://marketplace.visualstudio.com/items?itemName=swordev.phpstan) [![ci]](https://github.com/swordev/phpstan-vscode/actions/workflows/ci.yml) [![downloads]](https://marketplace.visualstudio.com/items?itemName=swordev.phpstan)
4+
5+
[ci]: https://img.shields.io/github/workflow/status/swordev/phpstan-vscode/CI?label=CI
6+
[version]: https://img.shields.io/visual-studio-marketplace/v/swordev.phpstan?logo=
7+
[downloads]: https://img.shields.io/visual-studio-marketplace/d/swordev.phpstan
68

79
[PHPStan](https://phpstan.org) extension for VSCode.
810

911
> Analyzes your PHP project manually or on every file change with PHPStan and shows the result in the VSCode problems tab.
1012
1113
## Features
1214

13-
- Activates the extension if it detects `phpstan.neon`/`phpstan.neon.dist` file on the project root dir.
1415
- Runs PHPStan analyse on every PHP file change.
1516
- Shows all PHPStan problems of the whole project.
16-
- Parses PHPStan config for file watching.
17+
- Parses the PHPStan config file for configuring the extension.
1718
- Commands:
1819
- `phpstan.showOutput`: show output.
1920
- `phpstan.analyse`: analyse.
2021
- `phpstan.analyseCurrentPath`: analyse current path.
2122
- Also available in the explorer context menu.
23+
- `phpstan.stopAnalyse`: stop analyse.
2224
- `phpstan.pauseFileWatcher`: pause file watcher.
2325
- `phpstan.resumeFileWatcher`: resume file watcher.
2426
- `phpstan.toggleFileWatcher`: toggle file watcher.

0 commit comments

Comments
 (0)