From 09dfc3aac46d2ffe23afe247dcf3c23f89fa0dd4 Mon Sep 17 00:00:00 2001 From: Maneesh Tewani Date: Tue, 29 Nov 2022 13:50:13 -0800 Subject: [PATCH] Updated local linkage instructions (#6817) --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 04953f697bb..803d4c40b41 100644 --- a/README.md +++ b/README.md @@ -190,14 +190,16 @@ scope](https://www.npmjs.com/search?q=scope%3Afirebase) on NPM. ### Testing the SDK Locally -Please be sure to build your repo before proceeding any further. +Please be sure your product's package has been built before proceeding any further. (If you haven't built this repo before, make sure to run `yarn build` at the root) In order to manually test your SDK changes locally, you must use [yarn link](https://classic.yarnpkg.com/en/docs/cli/link): ```shell $ cd packages/firebase $ yarn link # initialize the linking to the other folder -$ cd ../ # cd into your personal project directory -$ yarn link firebase # tell yarn to use the locally built firebase SDK instead +$ cd ../packages/ # Example: $ cd packages/database +$ yarn link # link your product to make it available elsewhere +$ cd # cd into your personal project directory +$ yarn link firebase @firebase/ # tell yarn to use the locally built firebase SDK instead ``` This will create a symlink and point your `` to the locally built version of the firebase SDK.