phptal / PHPTAL

PHP Template Attribute Language — template engine for XSS-proof well-formed XHTML and HTML5 pages
http://phptal.org
GNU Lesser General Public License v2.1
178 stars 42 forks source link

Update repository documentation #41

Open Potherca opened 9 years ago

Potherca commented 9 years ago

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

Anybody else have opinions/thoughts/suggestions about this?

usox commented 9 years ago

Add a CHANGELOG

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

Ocramius commented 9 years ago

A changelog is kinda required for breaking changes (at least). On Sep 1, 2015 10:42 AM, "usox" notifications@github.com 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 https://github.com/phptal/PHPTAL/issues/41#issuecomment-136651425.

usox commented 9 years ago

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 commented 9 years ago

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

usox commented 9 years ago

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