https://github.com/dahlia/jsr-badge

A badge generator for JSR (JavaScript Registry)
https://github.com/dahlia/jsr-badge

badge jsr

Last synced: 21 days ago
JSON representation

A badge generator for JSR (JavaScript Registry)

• Host: GitHub
• URL: https://github.com/dahlia/jsr-badge
• Owner: dahlia
• License: agpl-3.0
• Created: 2024-03-04T02:36:01.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-04T02:58:14.000Z (about 1 year ago)
• Last Synced: 2025-02-13T09:46:07.080Z (2 months ago)
• Topics: badge, jsr
• Language: TypeScript
• Homepage: https://jsr-badge.deno.dev/
• Size: 16.6 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
JSR Badge

=========

This is a simple badge generator for [JSR] (JavaScript Registry).  It is

intended to be used in the README files of JSR packages to indicate that the

package is registered with JSR.  Here is an example of the badge:

  

![@std/path](https://jsr-badge.deno.dev/@std/path/stable.svg)

The pattern for the URL is:

    https://jsr-badge.deno.dev/@//stable.svg

    https://jsr-badge.deno.dev/@//unstable.svg

Note that the unstable badge includes pre-releases, while the stable badge does

not.

Optionally, you can specify the following options in the query string:

| Option         | Format                                                      | Description                                          |

|----------------|-------------------------------------------------------------|------------------------------------------------------|

| `label`        | string without new line                                     | Shown in the left side.  The package URL by default. |

| `color`        | hex color code                                              | The right side color.  Red by default.               |

| `labelColor`   | hex color code                                              | The left side color.  Gray by default.               |

| `style`        | `plastic`, `flat`, `flat-square`, `for-the-badge`, `social` | The badge style.  `flat` by default.                 |

| `cacheSeconds` | seconds in decimal                                          | How long the cache to be alive.  An hour by default. |

[JSR]: https://jsr.io/