deblan/php-censor
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Improved status action (shield.io image) and docs

Browse source
This commit is contained in:
Dmitry Khomutov 2016-08-25 22:54:06 +07:00
commit e724504610
2 changed files with 30 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/en/status.md
View file

@ -9,6 +9,16 @@ Most Continuous Integration systems provide a simple image URL that you can use
You can find the status image at the following location: `http://{PHP_CENSOR_URL}/build-status/image/{PROJECT ID}`
So for example, our instance of PHP Censor is at `php-censor.local`, and our PHP Censor project ID is `2`, so the image URL is: `http://php-censor.local/build-status/image/2`.
You can use additional parameters:
* style: plastic | flat (default) | flat-squared | social
* label: build (default)
* logo
* logoWidth
* link
* maxAge
[See more on shields.io site](http://shields.io)
Example:
@ -25,10 +35,12 @@ Example:
http://php-censor.local/build-status/view/2
### Where do I find my project ID?
Go to your instance of PHP Censor, and open the project you are interested in. The project ID is the number in the last part of the URL in your browser.
Example:
http://php-censor.local/project/view/2 ~> PROJECT ID: `2`
### Enable/disable status image and page
You can enable or disable access to the public status image and page in your project's settings.