1
0
mirror of https://github.com/Luzifer/badge-gen.git synced 2024-09-07 17:39:08 +00:00
Web-Service to generate small badges
Go to file
2023-10-14 23:32:07 +02:00
assets display example path on hover 2016-07-07 01:33:24 +02:00
cache Fix linter errors 2023-09-08 14:23:22 +02:00
.gitignore Add Twitch service 2021-03-11 15:15:10 +01:00
.gobuilder.yml Added auto-trigger for docker builds 2015-05-25 14:30:12 +02:00
app.go Fix linter errors 2023-09-08 14:23:22 +02:00
assets.go Replace bindata with go:embed 2023-09-07 18:12:11 +02:00
config.md Add Twitch service 2021-03-11 15:15:10 +01:00
configStore.go add config storage 2016-07-05 15:48:57 +02:00
Dockerfile Update Dockerfile for go modules 2021-03-06 23:56:16 +01:00
font_test.go Replace bindata with go:embed 2023-09-07 18:12:11 +02:00
font.go Fix linter errors 2023-09-08 14:23:22 +02:00
go.mod Update dependencies 2023-10-14 23:31:29 +02:00
go.sum Update dependencies 2023-10-14 23:31:29 +02:00
History.md prepare release v1.17.1 2023-10-14 23:32:07 +02:00
LICENSE Replace license stub with full text 2018-03-21 16:34:44 +01:00
main_test.go Fix linter errors 2023-09-08 14:23:22 +02:00
Makefile Add documentation for configuration 2021-03-11 13:48:20 +01:00
metric_test.go add GitHub downloads integration 2016-07-07 01:25:09 +02:00
metric.go Fix linter errors 2023-09-08 14:23:22 +02:00
README.md Add documentation for configuration 2021-03-11 13:48:20 +01:00
service_aur.go Fix linter errors 2023-09-08 14:23:22 +02:00
service_github.go Fix linter errors 2023-09-08 14:23:22 +02:00
service_liberapay.go Fix linter errors 2023-09-08 14:23:22 +02:00
service_static.go Fix linter errors 2023-09-08 14:23:22 +02:00
service_travis.go Fix linter errors 2023-09-08 14:23:22 +02:00
service_twitch.go Fix linter errors 2023-09-08 14:23:22 +02:00

Go Report Card

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

For configuration options see config.md. These need to be supplied in a YAML file:

---

key: value

...

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!