luzifer/badge-gen
1
0
Fork 0
mirror of https://github.com/Luzifer/badge-gen.git synced 2024-11-08 13:20:02 +00:00
Code Issues Releases Wiki Activity

Document new service plugin

Browse source
This commit is contained in:
Knut Ahlers 2016-06-28 21:25:50 +02:00
parent 6cc67340f3
commit 2ef04ab45c
Signed by: luzifer
GPG key ID: DC2729FDD34BE99E
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -8,17 +8,12 @@ And I wasn't myself if I would allow me to do the same work twice or more often
### Using my version
Simple use one of these URLs:
Simple use the raw-API URL below or one of the URLs in the table at the bottom of this page:
```
https://badge.luzifer.io/v1/badge?title=API&text=Documentation&color=4c1
https://badge.luzifer.io/static/<title>/<text>/<color>
https://badge.luzifer.io/static/API/Documentation/4c1
```
![YourTitle](https://badge.luzifer.io/static/API/Documentation/4c1)
Parameters `title` and `text` are free-text strings while `color` has to be 3- or 6-letter hex notation for colors like that one you use in CSS.
To embed them into Markdown pages like this `README.md`:
@ -43,3 +38,10 @@ Hint: To get the source just look into the source of this README.md
![achievement](https://badge.luzifer.io/static/Achievement/You%20found%20a%20badge!/911)
Yeah, sure you even could fake your Travis-CI build status but seriously: Why should you do that? Shame on you if you do!
### Services
| Service | Example | URL Format |
| ------------ | ---------------------------------------------------------- | -------------------------------- |
| Static Badge | ![](https://badge.luzifer.io/static/API/Documentation/4c1) | `/static/<title>/<text>/<color>` |
| Travis-CI | ![](https://badge.luzifer.io/travis/Luzifer/password) | `/travis/<user>/<repo>/[branch]` |