-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e548be3
commit 69f38f2
Showing
2 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
description: JSR provides a badges for each package that can be used to showcase the package version or JSR score for a package. | ||
--- | ||
|
||
For every package, JSR provides an SVG badge that can be included in READMEs, | ||
documentation, or other places to showcase the package version or JSR score for | ||
a package. | ||
|
||
## Version Badge | ||
|
||
The version badge is a simple way to show the version of a package. It is | ||
available at the following URL: | ||
|
||
``` | ||
https://jsr.io/badges/@<scope>/<package> | ||
``` | ||
|
||
It looks like this: | ||
|
||
[![JSR](https://jsr.io/badges/@luca/flag)](https://jsr.io/@luca/flag) | ||
|
||
To include it in a markdown document, copy the following code and replace | ||
`<scope>` and `<package>` with the scope and package name of the package. | ||
|
||
```markdown | ||
[![](https://jsr.io/badges/@<scope>/<package>)](https://jsr.io/@<scope>/<package>) | ||
``` | ||
|
||
In a HTML document, use the following code: | ||
|
||
```html | ||
<a href="https://jsr.io/@<scope>/<package>"> | ||
<img src="https://jsr.io/badges/@<scope>/<package>" alt=""> | ||
</a> | ||
``` | ||
|
||
## JSR Score Badge | ||
|
||
The JSR score badge is a way to show the JSR score of a package. It is available | ||
at the following URL: | ||
|
||
``` | ||
https://jsr.io/badges/@<scope>/<package>/score | ||
``` | ||
|
||
It looks like this: | ||
|
||
[![JSR Score](https://jsr.io/badges/@luca/flag/score)](https://jsr.io/@luca/flag) | ||
|
||
To include it in a markdown document, copy the following code and replace | ||
`<scope>` and `<package>` with the scope and package name of the package. | ||
|
||
```markdown | ||
[![](https://jsr.io/badges/@<scope>/<package>/score)](https://jsr.io/@<scope>/<package>) | ||
``` | ||
|
||
In a HTML document, use the following code: | ||
|
||
```html | ||
<a href="https://jsr.io/@<scope>/<package>"> | ||
<img src="https://jsr.io/badges/@<scope>/<package>/score" alt=""> | ||
</a> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters