https://github.com/devlooped/shields
Custom endpoints for custom badges using https://shields.io/endpoint
https://github.com/devlooped/shields
Last synced: 4 months ago
JSON representation
Custom endpoints for custom badges using https://shields.io/endpoint
- Host: GitHub
- URL: https://github.com/devlooped/shields
- Owner: devlooped
- License: mit
- Created: 2020-10-19T16:15:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-21T17:36:45.000Z (about 1 year ago)
- Last Synced: 2025-04-21T18:36:46.522Z (about 1 year ago)
- Language: C#
- Size: 41 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shields endpoints
Custom endpoints for custom badges using https://shields.io/endpoint.
Main usage is to use as your shields badge the URL `https://img.shields.io/endpoint?url=https://shields.kzu.app/` followed by one of the supported endpoints below.
This service complements nicely [sleet](https://github.com/emgarten/Sleet)-powered feeds, but also virtually all CI systems that produce nuget feeds from build artifacts (Azure packaging example below).
# nuget version endpoints
The built-in [shields.io](https://shields.io/category/version) support for nuget versions only works with the nuget.org repository. We provide support for arbitrary feeds as follows:
```
[v|vpre]/[package id][/package label]?feed=[v3 feed]
```
> NOTE: package label is optional and can be used to filter pre-release packages
You can also abbreviate `feed` as just `f`.
| Badge | Url |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|  | `https://img.shields.io/endpoint?`
`url=https://shields.kzu.app/vpre/dotnet-stack?`
`f=pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json` |
|  | `https://img.shields.io/endpoint?color=68217A&`
`url=https://shields.kzu.app/v/dotnet-format?`
`f=pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-tools/nuget/v3/index.json` |
|  | `https://img.shields.io/endpoint?color=blue`
`url=https://shields.kzu.app/v/dotnet-file?`
`f=pkg.kzu.app/index.json` |
|  | `https://img.shields.io/endpoint?`
`url=https://shields.kzu.app/vpre/dotnet-config?`
`f=pkg.kzu.app/index.json` |
|  | `https://img.shields.io/endpoint?`
`url=https://shields.kzu.app/vpre/nugetizer?`
`f=pkg.kzu.app/index.json` |
|  | `https://img.shields.io/endpoint?`
`url=https://shields.kzu.app/vpre/nugetizer/main?`
`f=pkg.kzu.app/index.json` |
|  | `https://img.shields.io/endpoint?color=green&`
`url=https://shields.kzu.app/vpre/nugetizer/pr555?`
`f=pkg.kzu.app/index.json` |
|  | `https://img.shields.io/endpoint?labelColor=F4BE00&`
`color=black&logoColor=004880&logo=NuGet&style=flat-square&`
`url=https://shields.kzu.app/vpre/Moq/main` |
> NOTE: the `?feed=` must be the first querystring argument after the `url=https://shields.kzu.app` argument to `https://img.shields.io/endpoint`. That way, the subsequent query string arguments after the `&` will be interpreted as querystring arguments for shields.io. Alternatively, you can pass all the shields.io arguments *first* and leave the `&url=` as the last argument (which would only include the `?feed=` then), which is probably safest and easiest to remember.