From 2276b114c5a14df6f4bbd42f70c8e7fa4f2a8eae Mon Sep 17 00:00:00 2001 From: Cory Grinstead Date: Fri, 19 Jul 2024 18:48:24 -0500 Subject: [PATCH] docs: add installation note about yarn (#1459) 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. --- docs/src/basic.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/src/basic.md b/docs/src/basic.md index 02fd5ad4..88baf42d 100644 --- a/docs/src/basic.md +++ b/docs/src/basic.md @@ -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 @@ -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