1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-11 16:59:45 +01:00
psalm/README.md

34 lines
1.4 KiB
Markdown
Raw Normal View History

2019-12-04 21:18:00 +01:00
<h1>Psalm</h1>
2016-07-18 22:46:44 +02:00
[![Packagist](https://img.shields.io/packagist/v/vimeo/psalm.svg)](https://packagist.org/packages/vimeo/psalm)
2018-01-23 23:25:42 +01:00
[![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)
2019-03-31 20:02:30 +02:00
![Psalm coverage](https://shepherd.dev/github/vimeo/psalm/coverage.svg?)
2021-03-28 04:46:23 +02:00
[![Psalm level](https://shepherd.dev/github/vimeo/psalm/level.svg?)](https://psalm.dev/)
2019-03-24 14:47:39 +01:00
2020-11-20 01:40:17 +01:00
Psalm is a static analysis tool for finding errors in PHP applications.
2016-12-05 05:19:14 +01:00
2020-11-20 01:40:17 +01:00
## Installation
2016-11-11 20:19:31 +01:00
2020-11-20 01:40:17 +01:00
To get started, check out the [installation guide](docs/running_psalm/installation.md).
2020-11-20 01:40:17 +01:00
## Live Demo
2020-11-20 01:40:40 +01:00
You can play around with Psalm [on its website](https://psalm.dev/).
2020-11-20 01:40:17 +01:00
## Documentation
2016-11-21 21:15:23 +01:00
2020-11-20 01:40:17 +01:00
Documentation is available on [Psalms website](https://psalm.dev/docs), generated from the [docs](https://github.com/vimeo/psalm/blob/master/docs) folder.
2016-11-21 21:15:23 +01:00
2020-02-24 17:43:32 +01:00
## Interested in contributing?
2016-11-21 21:15:23 +01:00
2020-02-24 17:43:32 +01:00
Have a look at [CONTRIBUTING.md](CONTRIBUTING.md).
2020-11-20 01:40:17 +01:00
## Who made this
Built by Matt Brown ([@muglug](https://github.com/muglug)).
Maintained by Matt and Bruce Weirdan ([@weirdan](https://github.com/weirdan)).
2017-01-16 23:20:07 +01:00
2020-11-20 01:40:17 +01: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).