Skip to content

Commit da1ee81

Browse files
committed
Clean up readme's and small nits
1 parent 6fe4ffc commit da1ee81

File tree

7 files changed

+9
-27
lines changed

7 files changed

+9
-27
lines changed
Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
# @firebase/template
1+
# @firebase/auth-compat-exp
22

3-
This package can be used as a template for anyone creating new packages in the
4-
Firebase JS SDK. It will give you a couple things OOTB:
3+
This is a compatability layer to for the Firebase Authentication SDK
54

6-
- **Typescript Support:** Your code should be written in TS to be consistent
7-
with the rest of the SDK.
8-
- **Isomorphic Testing/Coverage:** Your tests will be run in both Node.js and
9-
Browser environments and coverage from both, collected.
10-
- **Links to all of the other packages:** Should your new package need to take
11-
a dependency on any of the other packages in this monorepo (e.g.
12-
`@firebase/app`, `@firebase/util`, etc), all those dependencies are already
13-
set up, you can just remove the ones you don't need.
5+
**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**

packages-exp/auth-compat-exp/index.node.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,4 @@
2424

2525
import { testFxn } from './src';
2626

27-
console.log('Hi Node.js Users!');
2827
testFxn();

packages-exp/auth-compat-exp/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
1616
"lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
1717
"build": "rollup -c",
18-
"build:deps": "lerna run --scope @firebase/'{app,template}' --include-dependencies build",
18+
"build:deps": "lerna run --scope @firebase/'{app,auth-compat-exp}' --include-dependencies build",
1919
"dev": "rollup -c -w",
2020
"test": "yarn type-check && run-p lint test:browser test:node",
2121
"test:browser": "karma start --single-run",

packages-exp/auth-exp/README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
# @firebase/template
1+
# @firebase/auth-exp
22

3-
This package can be used as a template for anyone creating new packages in the
4-
Firebase JS SDK. It will give you a couple things OOTB:
3+
This is the Firebase Authentication component of the Firebase JS SDK.
54

6-
- **Typescript Support:** Your code should be written in TS to be consistent
7-
with the rest of the SDK.
8-
- **Isomorphic Testing/Coverage:** Your tests will be run in both Node.js and
9-
Browser environments and coverage from both, collected.
10-
- **Links to all of the other packages:** Should your new package need to take
11-
a dependency on any of the other packages in this monorepo (e.g.
12-
`@firebase/app`, `@firebase/util`, etc), all those dependencies are already
13-
set up, you can just remove the ones you don't need.
5+
**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**

packages-exp/auth-exp/index.node.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,4 @@
2424

2525
import { testFxn } from './src';
2626

27-
console.log('Hi Node.js Users!');
2827
testFxn();

packages-exp/auth-exp/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
1616
"lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
1717
"build": "rollup -c",
18-
"build:deps": "lerna run --scope @firebase/'{app,template}' --include-dependencies build",
18+
"build:deps": "lerna run --scope @firebase/'{app,auth-exp}' --include-dependencies build",
1919
"dev": "rollup -c -w",
2020
"test": "yarn type-check && run-p lint test:browser test:node",
2121
"test:browser": "karma start --single-run",

packages-exp/auth-types-exp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# @firebase/template-types
1+
# @firebase/auth-types-exp
22

33
**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**

0 commit comments

Comments
 (0)