Update repository documentation

[Potherca]

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 to composer.json in Update readme + composer requirements; move license file and drop bui… #43, documentation needs to mention that the developer dependencies are added when running composer 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 to LICENSE - 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?

[usox]

Add a CHANGELOG

Do we really need a changelog file? Pointing to the projects release page on github should do the trick

[Ocramius]

A changelog is kinda required for breaking changes (at least).
On Sep 1, 2015 10:42 AM, "usox" [email protected] wrote:

Add a CHANGELOG

Do we really need a changelog file? Pointing to the projects release page
on github should do the trick

—
Reply to this email directly or view it on GitHub
#41 (comment).

[usox]

I updated the readme and the composer.json in our fork some time ago so I tried to backport some of the changes including some of the proposed suggestions. Any thoughts?
https://github.com/usox/PHPTAL/tree/WIP/readme_and_composer_update

[Ocramius]

@usox yes: send a PR for review :-)

[usox]

Well ok. Actually, I wanted to talk about dropping the phing targets before creating the pull request :-)