mirror of https://github.com/Luzifer/badge-gen.git synced 2024-11-08 13:20:02 +00:00

Web-Service to generate small badges

Find a file

Knut Ahlers b144013178 Prepared release v1.4.0		2016-06-28 23:56:48 +02:00
assets	Add demo page with / route	2016-06-28 23:56:22 +02:00
Godeps	Update Godeps	2016-06-28 19:38:58 +02:00
vendor	Update Godeps	2016-06-28 19:38:58 +02:00
.gitignore	Added Godeps	2015-05-25 15:12:18 +02:00
.gobuilder.yml	Added auto-trigger for docker builds	2015-05-25 14:30:12 +02:00
app.go	Add demo page with / route	2016-06-28 23:56:22 +02:00
bindata.go	Add demo page with / route	2016-06-28 23:56:22 +02:00
Dockerfile	Update Dockerfile to build binary in container	2016-06-28 19:40:45 +02:00
font.go	Refactor app, add support for service hooks	2016-06-28 19:35:48 +02:00
font_test.go	Added tests	2015-05-25 17:40:46 +02:00
History.md	Prepared release v1.4.0	2016-06-28 23:56:48 +02:00
LICENSE	Added license file	2015-05-25 20:23:18 +02:00
main_test.go	Added tests	2015-05-25 17:40:46 +02:00
README.md	Link to quay registry instead of DockerHub	2016-06-28 21:33:21 +02:00
service_static.go	Add demo page with / route	2016-06-28 23:56:22 +02:00
service_travis.go	Add demo page with / route	2016-06-28 23:56:22 +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 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

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](https://badge.luzifer.io/static/API/Documentation/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

Popular buttons rebuilt

Hint: To get the source just look into the source of this README.md

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		`/static/<title>/<text>/<color>`
Travis-CI		`/travis/<user>/<repo>/[branch]`