Skip to content

Commit b568ffc

Browse files
committed
docs: update readme
1 parent 2f2a610 commit b568ffc

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It downloads packages from the npm registry and analyzes them to extract their p
1313

1414
## Requirements
1515

16-
- [Bun](https://bun.sh/) must be installed to resolve and install packages
16+
- [Bun](https://bun.sh/) must be installed and available in the `PATH` to resolve and install packages
1717

1818
## API & Package Info
1919

@@ -31,7 +31,7 @@ It downloads packages from the npm registry and analyzes them to extract their p
3131
1. Analyze the latest version of the `preact` package from the npm registry:
3232

3333
```ts
34-
import { extractPackageApi } from "@jsdocs-io/extractor";
34+
import { getPackageApi } from "@jsdocs-io/extractor";
3535

3636
(async () => {
3737
const packageApi = await getPackageApi({ pkg: "preact" });
@@ -42,7 +42,7 @@ import { extractPackageApi } from "@jsdocs-io/extractor";
4242
2. Analyze a specific [subpath export](https://nodejs.org/api/packages.html#subpath-exports), like `preact/hooks`:
4343

4444
```ts
45-
import { extractPackageApi } from "@jsdocs-io/extractor";
45+
import { getPackageApi } from "@jsdocs-io/extractor";
4646

4747
(async () => {
4848
const result = await getPackageApi({ pkg: "preact", subpath: "hooks" });

0 commit comments

Comments
 (0)