diff --git a/README.md b/README.md index 013deff2b..07631cc3e 100644 --- a/README.md +++ b/README.md @@ -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).