mirror of https://github.com/Luzifer/badge-gen.git synced 2024-12-29 21:01:15 +00:00

Web-Service to generate small badges

Find a file

Knut Ahlers 4c42961ee8 Added svg minifying		2015-05-25 15:11:20 +02:00
assets	Added svg minifying	2015-05-25 15:11:20 +02:00
.gitignore	Initial version	2015-05-25 14:11:55 +02:00
.gobuilder.yml	Added auto-trigger for docker builds	2015-05-25 14:30:12 +02:00
bindata.go	Added svg minifying	2015-05-25 15:11:20 +02:00
Dockerfile	Added color, README and Dockerfile	2015-05-25 14:28:50 +02:00
font.go	Initial version	2015-05-25 14:11:55 +02:00
History.md	Prepared release 1.0.0	2015-05-25 14:56:53 +02:00
main.go	Added svg minifying	2015-05-25 15:11:20 +02:00
README.md	Fixed image code in README	2015-05-25 14:36:39 +02:00

README.md

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

Simple use this URL:

http://badge.luzifer.io/v1/badge?title=API&text=Documentation&color=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:

![YourTitle](http://badge.luzifer.io/v1/badge?title=API&text=Documentation&color=4c1)

Using your own hosted version

There is a Docker container for it. Just start it and use your own URL
You also can download the binary from GoBuilder.me and use that one