Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
juanrgm committed Sep 23, 2022
1 parent 09092d9 commit 6859b56
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
5 changes: 5 additions & 0 deletions .changeset/tough-buses-share.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"phpstan-vscode": patch
---

Update the readme file
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# phpstan-vscode

![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/swordev.phpstan)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/swordev/phpstan-vscode/CI)
![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/swordev.phpstan)
[![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)

[ci]: https://img.shields.io/github/workflow/status/swordev/phpstan-vscode/CI?label=CI
[version]: https://img.shields.io/visual-studio-marketplace/v/swordev.phpstan?logo=
[downloads]: https://img.shields.io/visual-studio-marketplace/d/swordev.phpstan

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

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

- Activates the extension if it detects `phpstan.neon`/`phpstan.neon.dist` file on the project root dir.
- Runs PHPStan analyse on every PHP file change.
- Shows all PHPStan problems of the whole project.
- Parses PHPStan config for file watching.
- Parses the PHPStan config file for configuring the extension.
- Commands:
- `phpstan.showOutput`: show output.
- `phpstan.analyse`: analyse.
- `phpstan.analyseCurrentPath`: analyse current path.
- Also available in the explorer context menu.
- `phpstan.stopAnalyse`: stop analyse.
- `phpstan.pauseFileWatcher`: pause file watcher.
- `phpstan.resumeFileWatcher`: resume file watcher.
- `phpstan.toggleFileWatcher`: toggle file watcher.
Expand Down

0 comments on commit 6859b56

Please sign in to comment.