Skip to content

Commit 4fdf03a

Browse files
committed
docs: add crates.io and jsr badges
1 parent 66c7b66 commit 4fdf03a

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# `deno_doc`
22

3+
[![](https://img.shields.io/crates/v/deno_doc.svg)](https://crates.io/crates/deno_doc)
4+
[![JSR](https://jsr.io/badges/@deno/doc)](https://jsr.io/@deno/doc)
5+
36
A Rust crate to generate documentation for JavaScript and TypeScript modules.
47

58
This crate powers

js/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# `deno_doc`
22

33
This repository includes a compiled version of the Rust crate as Web Assembly
4-
and exposes an interface which is available via the `mod.ts` and can be imported
5-
like this:
4+
and exposes an interface which is available via the `mod.ts`.
65

7-
```ts
8-
import { doc } from "jsr:@deno/doc@{VERSION}";
6+
Install:
7+
8+
```sh
9+
deno add jsr:@deno/doc
910
```
1011

11-
Where `{VERSION}` should be substituted with the specific version you want to
12-
use.
12+
Use:
13+
14+
```ts
15+
import { doc } from "@deno/doc";
16+
```
1317

1418
## `doc()`
1519

@@ -21,7 +25,7 @@ A minimal example of using `doc()` and printing out some information about a
2125
function:
2226

2327
```ts
24-
import { doc } from "jsr:@deno/doc@{VERSION}";
28+
import { doc } from "@deno/doc";
2529

2630
const colorsDoc = await doc("https://deno.land/std/fmt/colors.ts");
2731

0 commit comments

Comments
 (0)