Skip to content

Commit

Permalink
docs: add installation note about yarn (lancedb#1459)
Browse files Browse the repository at this point in the history
I noticed that setting up a simple project with
[Yarn](https://yarnpkg.com/) failed because unlike others [npm, pnpm,
bun], yarn does not automatically resolve peer dependencies, so i added
a quick note about it in the installation guide.
  • Loading branch information
universalmind303 authored Jul 19, 2024
1 parent 3b88f15 commit 2276b11
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/src/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,15 @@
}
})
```

!!! note "Yarn users"

Unlike other package managers, Yarn does not automatically resolve peer dependencies. If you are using Yarn, you will need to manually install 'apache-arrow':

```shell
yarn add apache-arrow
```

=== "vectordb (deprecated)"

```shell
Expand All @@ -53,6 +62,15 @@
}
})
```

!!! note "Yarn users"

Unlike other package managers, Yarn does not automatically resolve peer dependencies. If you are using Yarn, you will need to manually install 'apache-arrow':

```shell
yarn add apache-arrow
```

=== "Rust"

```shell
Expand Down

0 comments on commit 2276b11

Please sign in to comment.