Open
Description
Various parts of the README
file need updating or changing to be more up-to-date. Also, some additions seem in order.
My suggestions would be to:
Readme File
- Update the PHPUnit version - Update readme + composer requirements; move license file and drop bui… #43
- Add install instructions for Composer - Update readme + composer requirements; move license file and drop bui… #43
- Remove the PEAR section in favour of using Composer/Packagist - Update readme + composer requirements; move license file and drop bui… #43
- Point the package link to Github releases rather than to http://phptal.org - Update readme + composer requirements; move license file and drop bui… #43
- Point the development link to Github rather than https://svn.motion-twin.com/ - Update readme + composer requirements; move license file and drop bui… #43
- Add a license badge
- Update readme + composer requirements; move license file and drop bui… #43
- Add a Packagist badge
- Update readme + composer requirements; move license file and drop bui… #43
- Add Scrutinizer badge
- Update readme + composer requirements; move license file and drop bui… #43
- Update the location of the Travis build:
- Update readme + composer requirements; move license file and drop bui… #43
- Update the development section to use Composer to install development dependencies
(Dependencies have already been added tocomposer.json
in Update readme + composer requirements; move license file and drop bui… #43, documentation needs to mention that the developer dependencies are added when runningcomposer install
). - Add Credits to honor the original authors and to add the maintainers (to avoid confusion about who is responsible for what)
Other files
- Add a
CONTRIBUTING.md
file - Rename
COPYING
toLICENSE
- Update readme + composer requirements; move license file and drop bui… #43 - Add a
CHANGELOG
- Add a CHANGELOG #52
Anybody else have opinions/thoughts/suggestions about this?