mirror of
https://github.com/danog/psalm.git
synced 2024-11-27 04:45:20 +01:00
29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
<h1>Psalm</h1>
|
||
|
||
[![Packagist](https://img.shields.io/packagist/v/vimeo/psalm.svg)](https://packagist.org/packages/vimeo/psalm)
|
||
[![Packagist](https://img.shields.io/packagist/dt/vimeo/psalm.svg)](https://packagist.org/packages/vimeo/psalm)
|
||
[![Travis CI](https://img.shields.io/travis/vimeo/psalm/master.svg)](https://travis-ci.org/vimeo/psalm/branches)
|
||
[![Coverage Status](https://coveralls.io/repos/github/vimeo/psalm/badge.svg)](https://coveralls.io/github/vimeo/psalm)
|
||
![Psalm coverage](https://shepherd.dev/github/vimeo/psalm/coverage.svg?)
|
||
|
||
|
||
Psalm is a static analysis tool for finding errors in PHP applications, built on top of [PHP Parser](https://github.com/nikic/php-parser).
|
||
|
||
It's able to find a [large number of issues](https://github.com/vimeo/psalm/blob/master/docs/running_psalm/issues.md), but it can also be configured to only care about a small subset of those.
|
||
|
||
[Try a live demo](https://psalm.dev/), or install it in your project by following the Quickstart Guide below.
|
||
|
||
## Psalm documentation
|
||
|
||
Documentation is available on [Psalm’s website](https://psalm.dev/docs), generated from the [docs](https://github.com/vimeo/psalm/blob/master/docs) folder.
|
||
|
||
To get started, check out the [installation guide](docs/running_psalm/installation.md)
|
||
|
||
## Interested in contributing?
|
||
|
||
Have a look at [CONTRIBUTING.md](CONTRIBUTING.md).
|
||
|
||
## Acknowledgements
|
||
|
||
The engineering team [@vimeo](https://github.com/vimeo) for encouragement and patience, especially [@nbeliard](https://github.com/nbeliard), [@erunion](https://github.com/erunion) and [@nickyr](https://github.com/nickyr).
|