Skip to content

Commit

Permalink
Fix minor mistakes in the root README (#8242)
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque authored May 14, 2024
1 parent 8fb372a commit 9cbb184
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/.

Expand All @@ -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
```
Expand Down Expand Up @@ -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/<my-product> # Example: $ cd packages/database
$ cd ../<my-product> # Example: $ cd ../firestore
$ yarn link # link your product to make it available elsewhere
$ cd <my-test-app-dir> # cd into your personal project directory
$ yarn link firebase @firebase/<my-product> # tell yarn to use the locally built firebase SDK instead
Expand Down

0 comments on commit 9cbb184

Please sign in to comment.