From 9cbb1845e2b606d14601d2545e224dbf1f534027 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Tue, 14 May 2024 09:26:06 -0400 Subject: [PATCH] Fix minor mistakes in the root README (#8242) --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dadbc48ec36..cbac0a604d4 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,11 @@ To get started using Firebase, see [![Release Notes](https://img.shields.io/npm/v/firebase.svg?style=flat-square&label=Release%20Notes%20for&labelColor=039be5&color=666)](https://firebase.google.com/support/release-notes/js) ## Upgrade to Version 9 + Version 9 has a redesigned API that supports tree-shaking. Read the [Upgrade Guide](https://firebase.google.com/docs/web/modular-upgrade) to learn more. + ## Supported Environments + Please see [Environment Support](https://firebase.google.com/support/guides/environments_js-sdk). ## SDK Dev Workflow @@ -30,7 +33,7 @@ Please see [Environment Support](https://firebase.google.com/support/guides/envi Before you can start working on the Firebase JS SDK, you need to have Node.js installed on your machine. As of April 19th, 2024 the team has been testing with Node.js version -`20.12.2`, but the required verison of Node.js may change as we update our dependencies. +`20.12.2`, but the required version of Node.js may change as we update our dependencies. To download Node.js visit https://nodejs.org/en/download/. @@ -44,7 +47,7 @@ In addition to Node.js we use `yarn` to facilitate multi package development. To install `yarn` follow the instructions listed on their website: https://yarnpkg.com/en/docs/install -This repo currently supports building with yarn `1.x`. For instance, after installating yarn, run +This repo currently supports building with yarn `1.x`. For instance, after installing yarn, run ```bash $ yarn set version 1.22.11 ``` @@ -204,7 +207,7 @@ In order to manually test your SDK changes locally, you must use [yarn link](htt ```shell $ cd packages/firebase $ yarn link # initialize the linking to the other folder -$ cd ../packages/ # Example: $ cd packages/database +$ cd ../ # Example: $ cd ../firestore $ 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