danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-29 20:28:59 +01:00
Code Issues Projects Releases Wiki Activity

Make Readme more punchy

Browse Source
This commit is contained in:
Matthew Brown 2020-11-19 19:40:17 -05:00 committed by Daniil Gentili
parent 2c998aea7e
commit 534b1d135a
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -2,27 +2,32 @@
[![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).
Psalm is a static analysis tool for finding errors in PHP applications.
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.
## Installation
[Try a live demo](https://psalm.dev/), or install it in your project by following the Quickstart Guide below.
To get started, check out the [installation guide](docs/running_psalm/installation.md).
## Psalm documentation
## Live Demo
You can play around with Psalm [on the 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.
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
## Who made this
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).
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).