psalm/README.md

<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)
[![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 level](https://shepherd.dev/github/vimeo/psalm/level.svg?)](https://psalm.dev/)

Psalm is a static analysis tool for finding errors in PHP applications.

## Installation

To get started, check out the [installation guide](docs/running_psalm/installation.md).

## Live Demo

You can play around with Psalm [on its website](https://psalm.dev/).

## 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.

## Interested in contributing?

Have a look at [CONTRIBUTING.md](CONTRIBUTING.md).

## Who made this

Built by Matt Brown ([@muglug](https://github.com/muglug)).

Maintained by Matt and Bruce Weirdan ([@weirdan](https://github.com/weirdan)).

The engineering team at [Vimeo](https://github.com/vimeo) have provided a lot encouragement, especially [@nbeliard](https://github.com/nbeliard), [@erunion](https://github.com/erunion) and [@nickyr](https://github.com/nickyr).
-												Simplify logo
											
										
										
											2019-12-04 15:18:00 -05:00
+								<h1>Psalm</h1>
-												Change the name
											
										
										
											2016-07-18 16:46:44 -04:00
-												Making the README badges clickable, and adding one for Packagist.

											
										
										
											2017-02-03 21:35:40 -05:00
+								[![Packagist](https://img.shields.io/packagist/v/vimeo/psalm.svg)](https://packagist.org/packages/vimeo/psalm)
-												Add total downloads
											
										
										
											2018-01-23 17:25:42 -05:00
+								[![Packagist](https://img.shields.io/packagist/dt/vimeo/psalm.svg)](https://packagist.org/packages/vimeo/psalm)
-												Add code coverage checks by @SignpostMarv (#388)

* Add code coverage checks

* Add coveralls badge

											
										
										
											2017-12-14 00:40:22 -05:00
+								[![Coverage Status](https://coveralls.io/repos/github/vimeo/psalm/badge.svg)](https://coveralls.io/github/vimeo/psalm)
-												spirit => shepherd

											
										
										
											2019-03-31 14:02:30 -04:00
+								![Psalm coverage](https://shepherd.dev/github/vimeo/psalm/coverage.svg?)
-												Fix reference

											
										
										
											2021-03-27 22:46:23 -04:00
+								[![Psalm level](https://shepherd.dev/github/vimeo/psalm/level.svg?)](https://psalm.dev/)
-												Add return to jog things
											
										
										
											2019-03-24 09:47:39 -04:00
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
+								Psalm is a static analysis tool for finding errors in PHP applications.
-												Update minimum requirements

											
										
										
											2016-12-04 23:19:14 -05:00
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
+								## Installation
-												Improve introduction
											
										
										
											2016-11-11 14:19:31 -05:00
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
+								To get started, check out the [installation guide](docs/running_psalm/installation.md).
-												Add explicit callout to the documentation

Ref #596
											
										
										
											2018-03-18 09:07:36 -04:00
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
+								## Live Demo
-												Add explicit callout to the documentation

Ref #596
											
										
										
											2018-03-18 09:07:36 -04:00
-												Grammar
											
										
										
											2020-11-19 19:40:40 -05:00
+								You can play around with Psalm [on its website](https://psalm.dev/).
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
 								## Documentation
-												Add quickstart guide
											
										
										
											2016-11-21 15:15:23 -05:00
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
+								Documentation is available on [Psalm’s website](https://psalm.dev/docs), generated from the [docs](https://github.com/vimeo/psalm/blob/master/docs) folder.
-												Add quickstart guide
											
										
										
											2016-11-21 15:15:23 -05:00
-												Shortened the readme
											
										
										
											2020-02-24 11:43:32 -05:00
+								## Interested in contributing?
-												Add quickstart guide
											
										
										
											2016-11-21 15:15:23 -05:00
-												Shortened the readme
											
										
										
											2020-02-24 11:43:32 -05:00
+								Have a look at [CONTRIBUTING.md](CONTRIBUTING.md).
-												Add reference to how Psalm works overview

											
										
										
											2018-01-14 15:35:52 -05:00
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
+								## Who made this
 								Built by Matt Brown ([@muglug](https://github.com/muglug)).
 								Maintained by Matt and Bruce Weirdan ([@weirdan](https://github.com/weirdan)).
-												Added acknowledgements
											
										
										
											2017-01-16 17:20:07 -05:00
-												Make Readme more punchy
											
										
										
											2020-11-19 19:40:17 -05:00
+								The engineering team at [Vimeo](https://github.com/vimeo) have provided a lot encouragement, especially [@nbeliard](https://github.com/nbeliard), [@erunion](https://github.com/erunion) and [@nickyr](https://github.com/nickyr).