Skip to content

Commit 7daa036

Browse files
committed
docs(tests): update README.md to include the necessary project.json instructions
1 parent a3cca2d commit 7daa036

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,18 @@ gulp --tasks
5858

5959
## Testing the SDK
6060

61-
To run all tests for the SDK simply run: `npm test` at the root of this package.
61+
To run all tests for the SDK you must first supply a firebase project config for
62+
your tests. This is done by creating a file called `project.json` and at the
63+
following path:
64+
65+
```
66+
tests/config/project.json
67+
```
68+
69+
This file should contain a JSON object with your app information (i.e. the same
70+
information you would pass to `firebase.initializeApp`).
71+
72+
After you have done this, simply run: `npm test` at the root of this package.
6273

6374
There are several types of available tests:
6475

0 commit comments

Comments
 (0)