Skip to content

Commit 7c62b0c

Browse files
authored
Make Readme more punchy
1 parent acb4bb4 commit 7c62b0c

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,32 @@
22

33
[![Packagist](https://img.shields.io/packagist/v/vimeo/psalm.svg)](https://packagist.org/packages/vimeo/psalm)
44
[![Packagist](https://img.shields.io/packagist/dt/vimeo/psalm.svg)](https://packagist.org/packages/vimeo/psalm)
5-
[![Travis CI](https://img.shields.io/travis/vimeo/psalm/master.svg)](https://travis-ci.org/vimeo/psalm/branches)
65
[![Coverage Status](https://coveralls.io/repos/github/vimeo/psalm/badge.svg)](https://coveralls.io/github/vimeo/psalm)
76
![Psalm coverage](https://shepherd.dev/github/vimeo/psalm/coverage.svg?)
87

98

10-
Psalm is a static analysis tool for finding errors in PHP applications, built on top of [PHP Parser](https://github.com/nikic/php-parser).
9+
Psalm is a static analysis tool for finding errors in PHP applications.
1110

12-
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.
11+
## Installation
1312

14-
[Try a live demo](https://psalm.dev/), or install it in your project by following the Quickstart Guide below.
13+
To get started, check out the [installation guide](docs/running_psalm/installation.md).
1514

16-
## Psalm documentation
15+
## Live Demo
1716

18-
Documentation is available on [Psalm’s website](https://psalm.dev/docs), generated from the [docs](https://github.com/vimeo/psalm/blob/master/docs) folder.
17+
You can play around with Psalm [on the website](https://psalm.dev/).
18+
19+
## Documentation
1920

20-
To get started, check out the [installation guide](docs/running_psalm/installation.md)
21+
Documentation is available on [Psalm’s website](https://psalm.dev/docs), generated from the [docs](https://github.com/vimeo/psalm/blob/master/docs) folder.
2122

2223
## Interested in contributing?
2324

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

26-
## Acknowledgements
27+
## Who made this
28+
29+
Built by Matt Brown ([@muglug](https://github.com/muglug)).
30+
31+
Maintained by Matt and Bruce Weirdan ([@weirdan](https://github.com/weirdan)).
2732

28-
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).
33+
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).

0 commit comments

Comments
 (0)