Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badges/buckler
Go library and CLI for making Shields-style badges (PNG)
https://github.com/badges/buckler
Last synced: 7 days ago
JSON representation
Go library and CLI for making Shields-style badges (PNG)
- Host: GitHub
- URL: https://github.com/badges/buckler
- Owner: badges
- License: other
- Archived: true
- Created: 2013-06-29T11:43:48.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-11-05T20:36:22.000Z (about 8 years ago)
- Last Synced: 2024-08-03T20:10:36.320Z (4 months ago)
- Language: Go
- Homepage: http://buckler.repl.ca/
- Size: 1.36 MB
- Stars: 300
- Watchers: 13
- Forks: 29
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⛨ Buckler ⛨
[](http://github.com/badges/stability-badges)
[](https://travis-ci.org/badges/buckler)
[](http://buckler.repl.ca)
[](http://buckler.repl.ca)
[](LICENSE)
[](#command-line)
Buckler is [Shields](https://github.com/badges/shields) as a Service (ShaaS, or alternatively, Badges as a Service)
for use in GitHub READMEs, or anywhere else. Use buckler with your favorite continuous integration tool, performance
monitoring service API, or ridiculous in-joke to surface information.
Buckler is available hosted at [b.repl.ca](http://buckler.repl.ca). You may use the [API](#API) to generate shields at runtime,
pregenerate them and host them on your own service, or run your own copy of Buckler to protect important company secrets.
# API
Buckler tries to make creating shields easy. Each shield request is a url that has three parts:
- `subject`
- `status`
- `colour`
Parts are separated by a hyphen. The request is suffixed by `.png` and prefixed with the Buckler host and API version, likely
`b.repl.ca/v1/`. Requests will take the form: `http://b.repl.ca/v1/$SUBJECT-$STATUS-$COLOR.png`
## Examples
- http://b.repl.ca/v1/build-passing-brightgreen.png ⇨ 
- http://b.repl.ca/v1/downloads-3.4K-blue.png ⇨ 
- http://b.repl.ca/v1/coverage-unknown-lightgrey.png ⇨ 
- http://b.repl.ca/v1/review-NACKED-red.png ⇨ 
- http://b.repl.ca/v1/enterprise-ready-ff69b4.png ⇨ 
## Valid Colours
- `brightgreen` ⇨ 
- `green` ⇨ 
- `yellowgreen` ⇨ 
- `yellow` ⇨ 
- `orange` ⇨ 
- `red` ⇨ 
- `grey` ⇨ 
- `lightgrey` ⇨ 
- `blue` ⇨ 
Six digit RGB hexidecimal colour values work as well:
- `804000` - 
### Grey?
Don't worry; `gray` and `lightgray` work too.
## Escaping Underscores and Hyphens
Hyphens (`-`) are used to delimit individual fields in your shield request. To include a literal hyphen, use two hyphens (`--`):
http://b.repl.ca/v1/really--cool-status-yellow.png ⇨ 
Similarly, underscores (`_`) are used to indicated spaces. To include a literal underscore, use two underscores (`__`):
http://b.repl.ca/v1/__private-method_name-lightgrey.png ⇨ 
## URL Safe
Buckler API requests are just HTTP GETs, so remember to URL encode!
http://b.repl.ca/v1/uptime-99.99%25-yellowgreen.png ⇨ 
# Try It Out
Play around with the simple form on [b.repl.ca](http://b.repl.ca)
# Installing
```bash
go get github.com/badges/buckler
```
Alternatively, `git clone` and `go build` to run from source.
# Command Line
Buckler also provides a command line interface:
```bash
# writes to build-passing-brightgreen.png
buckler -v build -s passing -c brightgreen
# writes to my-custom-filename.png
buckler -v build -s passing -c green my-custom-filename.png
# writes to standard out
buckler -v license -s MIT -c blue -
# writes 2 shields
buckler build-passing-brightgreen.png license-MIT-blue.png
```
# Thanks
- Olivier Lacan for the [shields](https://github.com/badges/shields) repo
- Steve Matteson for [Open Sans](http://opensans.com/)