1
0
Fork 0
mirror of https://github.com/Luzifer/badge-gen.git synced 2024-12-20 16:41:16 +00:00
Web-Service to generate small badges
Find a file
Knut Ahlers 45baca1b4a
Replace license stub with full text
Signed-off-by: Knut Ahlers <knut@ahlers.me>
2018-03-21 16:34:44 +01:00
assets display example path on hover 2016-07-07 01:33:24 +02:00
cache Add caching results of API calls 2016-06-29 15:13:26 +02:00
Godeps fix missing godeps 2016-07-07 15:30:54 +02:00
vendor fix missing godeps 2016-07-07 15:30:54 +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 metrics collection 2016-07-07 15:24:33 +02:00
bindata.go display example path on hover 2016-07-07 01:33:24 +02:00
configStore.go add config storage 2016-07-05 15:48:57 +02:00
Dockerfile add config storage 2016-07-05 15:48:57 +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 prepare release v1.12.0 2018-03-21 16:28:17 +01:00
LICENSE Replace license stub with full text 2018-03-21 16:34:44 +01:00
main_test.go Added tests 2015-05-25 17:40:46 +02:00
metric.go add GitHub downloads integration 2016-07-07 01:25:09 +02:00
metric_test.go add GitHub downloads integration 2016-07-07 01:25:09 +02:00
metrics.go add metrics collection 2016-07-07 15:24:33 +02:00
README.md Switched to new URL for hosted version 2016-06-29 10:10:13 +02:00
service_beerpay.go add caching to beerpay API 2016-07-06 00:45:11 +02:00
service_github.go add metrics collection 2016-07-07 15:24:33 +02:00
service_static.go Allow multiple documentation entries per handler 2016-06-29 13:09:08 +02:00
service_travis.go Add caching results of API calls 2016-06-29 15:13:26 +02: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

Simple use the raw-API URL below or one of the URLs listed on the demo page:

https://badges.fyi/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:

![YourTitle](https://badges.fyi/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

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

godoc reference API Documentation gratipay support gitter chat achievement

Yeah, sure you even could fake your Travis-CI build status but seriously: Why should you do that? Shame on you if you do!