2021-03-11 11:40:23 +00:00
[](https://goreportcard.com/report/github.com/Luzifer/badge-gen)
2015-05-25 12:28:50 +00:00
# Luzifer / badge-gen
Ever ran into this scenario? You wanted to add a link to something to your GitHub project using a nice button like the Godoc or the Travis-CI button but you was not able to find a button for this having the text you wanted? I did. I wanted to add a button "API Documentation" to one of my projects and did not find any button with that caption. So I wrote it myself.
And I wasn't myself if I would allow me to do the same work twice or more often so I wrote a small webserver able to generate those buttons with a customizable text in SVG (I did not care about older browser since long ago)…
## Usage
### Using my version
2016-06-29 08:10:13 +00:00
Simple use the raw-API URL below or one of the URLs listed on the [demo page ](https://badges.fyi/ ):
2015-05-25 12:28:50 +00:00
```
2016-06-29 08:10:13 +00:00
https://badges.fyi/static/API/Documentation/4c1
2015-05-25 12:28:50 +00:00
```
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` :
```
2016-06-29 08:10:13 +00:00
2015-05-25 12:28:50 +00:00
```
### Using your own hosted version
2016-06-28 19:33:21 +00:00
- There is a [Docker container ](https://quay.io/repository/luzifer/badge-gen ) for it. Just start it and use your own URL
2015-05-25 16:13:53 +00:00
2021-03-11 12:48:20 +00:00
For configuration options see [config.md ](config.md ). These need to be supplied in a YAML file:
```yaml
---
key: value
...
```
2015-05-25 16:13:53 +00:00
### Popular buttons rebuilt
Hint: To get the source just look into the source of this README.md
2016-06-29 08:10:13 +00:00
2015-05-25 16:13:53 +00:00
Yeah, sure you even could fake your Travis-CI build status but seriously: Why should you do that? Shame on you if you do!
