Poser, add badges on your readme, such as downloads number or latest version.
NOTE: Development has stopped on version 2 (master branch).
Version 3 is under development and will be released soon. For new contributions, please use the version 3 release branch (release/v3.0.0).
Use shields for your packagist.org repository that shows how many times your project has been downloaded from packagist.org or its latest stable version.
- Go to the Badge Poser website
- Insert username/repository and click on
- That's it! Copy the Markdown into the README.md
Not only because all the other languages already have it, but having the latest stable release in the readme could save time.
Active contribution and patches are very welcome. See the github issues. There are some tagged as easy-pick. To keep things in shape we have a bunch of unit tests. If you're submitting pull requests please make sure that they are still passing and if you add functionality please take a look at the coverage as well, it should be pretty high. :)
- First, fork or clone the repository:
git clone git://github.com/PUGX/badge-poser.git cd badge-poser
- Install vendors:
php composer.phar self-update php composer.phar install
- Run phpunit:
- For Production purposes you need Redis.
- Update the contributors
bin/extract_contributors.py > src/PUGX/BadgeBundle/Resources/views/Page/contributors.html.twig
Badge Poser serves billion of images per month. We really dream to move all of our code on Amazon AWS but is up to you.
If you use Badge Poser and you like it, please consider to donate. Thank you!
In order to update the contributors section:
- install it running
pip install pygithub3 && pip install Jinja2
python bin/extract_contributors.py > src/PUGX/BadgeBundle/Resources/views/Page/contributors.html.twig