-
Notifications
You must be signed in to change notification settings - Fork 927
Update READMEs #3551
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update READMEs #3551
Conversation
💥 No ChangesetLatest commit: bc409b9 Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂 If these changes should be published to npm, you need to add a changeset. This PR includes no changesetsWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Click here to learn what changesets are, and how to add one. Click here if you're a maintainer who wants to add a changeset to this PR |
Binary Size ReportAffected SDKs
Test Logs |
@@ -2,19 +2,3 @@ | |||
|
|||
_NOTE: This is specifically tailored for Firebase JS SDK usage, if you are not a | |||
member of the Firebase team, please avoid using this package_ | |||
|
|||
## Installation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's okay to keep this section for internal packages in order to provide instruction for Googlers. We have clearly stated that this package is intended to be only used by the Firebase team, so I don't think there is any confusion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I restored Usage but kept Installation removed because I don't think any internal user would (or should) npm install it?
$ npm install @firebase/util | ||
``` | ||
|
||
## Usage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
restore the usage?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Restored.
Since READMEs show up on the npm website, we should make sure they are updated and consistent. Some example import patterns were inconsistent (e.g.
import firebase from 'firebase/app'
vsimport * as firebase from 'firebase/app'
).import * as firebase
pattern.Fixes #3514