-
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.
- Consistently refer to Node.js as Node.js, not Node. - Other minor improvements.
- Loading branch information
Showing
19 changed files
with
88 additions
and
89 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
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
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 |
---|---|---|
@@ -1,63 +1,62 @@ | ||
--- | ||
description: JSR provides a badges for each package that can be used to showcase the package version or JSR score for a package. | ||
description: JSR provides badges for each package that can be used to showcase its latest version or its JSR score. | ||
--- | ||
|
||
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. | ||
JSR provides badges for each package that can be used to showcase its latest | ||
version or its JSR score. | ||
|
||
## Version Badge | ||
|
||
The version badge is a simple way to show the version of a package. It is | ||
The version badge can be used to showcase the version of a package. It is | ||
available at the following URL: | ||
|
||
``` | ||
https://jsr.io/badges/@<scope>/<package> | ||
``` | ||
|
||
It looks like this: | ||
Here's how it looks: | ||
|
||
[![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. | ||
To include it in a Markdown document, use the following code, replacing | ||
`<scope>` and `<package>` with the actual scope and name of the package. | ||
|
||
```markdown | ||
[![](https://jsr.io/badges/@<scope>/<package>)](https://jsr.io/@<scope>/<package>) | ||
[![JSR](https://jsr.io/badges/@<scope>/<package>)](https://jsr.io/@<scope>/<package>) | ||
``` | ||
|
||
In a HTML document, use the following code: | ||
In HTML documents, the following can be used: | ||
|
||
```html | ||
<a href="https://jsr.io/@<scope>/<package>"> | ||
<img src="https://jsr.io/badges/@<scope>/<package>" alt=""> | ||
<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: | ||
The JSR score badge can be used to showcase the JSR score of a package. It is | ||
available at the following URL: | ||
|
||
``` | ||
https://jsr.io/badges/@<scope>/<package>/score | ||
``` | ||
|
||
It looks like this: | ||
Here's how it looks: | ||
|
||
[![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. | ||
To include it in a Markdown document, use the following code, replacing | ||
`<scope>` and `<package>` with the actual scope and name of the package. | ||
|
||
```markdown | ||
[![](https://jsr.io/badges/@<scope>/<package>/score)](https://jsr.io/@<scope>/<package>) | ||
[![JSR Score](https://jsr.io/badges/@<scope>/<package>/score)](https://jsr.io/@<scope>/<package>) | ||
``` | ||
|
||
In a HTML document, use the following code: | ||
In HTML documents, the following can be used: | ||
|
||
```html | ||
<a href="https://jsr.io/@<scope>/<package>"> | ||
<img src="https://jsr.io/badges/@<scope>/<package>/score" alt=""> | ||
<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
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
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 |
---|---|---|
|
@@ -4,9 +4,9 @@ description: JSR is a new modern package registry for JavaScript and TypeScript. | |
--- | ||
|
||
The JavaScript Registry (**JSR**) is a modern package registry for JavaScript | ||
and TypeScript. JSR works with many runtimes (Node, Deno, browsers, and more) | ||
and TypeScript. JSR works with many runtimes (Node.js, Deno, browsers, and more) | ||
and is backwards compatible with npm. | ||
[Learn more about why we built JSR](/docs/why). | ||
[Learn more about why we built JSR.](/docs/why) | ||
|
||
## Using JSR packages | ||
|
||
|
@@ -42,8 +42,7 @@ camelCase("hello world"); // "helloWorld" | |
|
||
You can find more packages on [jsr.io](https://jsr.io). Each package on the JSR | ||
site also displays documentation, which is automatically generated from the | ||
package's source code. | ||
[Learn more about using JSR packages](/docs/using-packages). | ||
package's source code. [Learn more about using packages.](/docs/using-packages) | ||
|
||
## Publishing JSR packages | ||
|
||
|
@@ -98,4 +97,4 @@ Successfully published @luca/[email protected] | |
Visit https://jsr.io/@luca/[email protected] for details | ||
``` | ||
|
||
Learn more about [publishing JSR packages](/docs/publishing-packages). | ||
[Learn more about publishing packages.](/docs/publishing-packages) |
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
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
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
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
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
Oops, something went wrong.