Skip to content

Commit cdec4db

Browse files
docs: improve jsr documentation (#1197)
1 parent ad0dc7d commit cdec4db

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,21 @@ The REST API documentation can be found on [platform.openai.com](https://platfor
1212
npm install openai
1313
```
1414

15-
You can also import from jsr:
15+
### Installation from JSR
1616

17-
<!-- x-release-please-start-version -->
17+
```sh
18+
deno add jsr:@openai/openai
19+
npx jsr add @openai/openai
20+
```
21+
22+
These commands will make the module importable from the `@openai/openai` scope:
23+
24+
You can also [import directly from JSR](https://jsr.io/docs/using-packages#importing-with-jsr-specifiers) without an install step if you're using the Deno JavaScript runtime:
1825

1926
```ts
2027
import OpenAI from 'jsr:@openai/openai';
2128
```
2229

23-
<!-- x-release-please-end -->
24-
2530
## Usage
2631

2732
The full API of this library can be found in [api.md](api.md).
@@ -388,7 +393,7 @@ TypeScript >= 4.5 is supported.
388393
The following runtimes are supported:
389394

390395
- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
391-
- Deno v1.28.0 or higher, using `import OpenAI from "npm:openai"`.
396+
- Deno v1.28.0 or higher.
392397
- Bun 1.0 or later.
393398
- Cloudflare Workers.
394399
- Vercel Edge Runtime.

0 commit comments

Comments
 (0)