Skip to content
This repository was archived by the owner on Jun 3, 2022. It is now read-only.

Commit da41011

Browse files
authored
Adds Firebase configuration documentation.
1 parent 095254e commit da41011

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,28 @@ This will install the Remixer files in your project's `node_modules` folder.
2828
remixer.start();
2929
```
3030

31-
### 4. Add variables.
31+
### 4. (Optional) Configure the Web Remote Controller
32+
33+
This **optional** step is only needed if you wish to use the Web Remote Controller. If so, follow these guidelines:
34+
35+
- Set up a new or existing [Firebase](https://firebase.google.com/) account as detailed in the [Web Remote Controller](https://github.com/material-foundation/material-remixer-remote-web) repository.
36+
- Add your Firebase account credentials to your app, and forward the param to the `remixer.start()` method.
37+
38+
```javascript
39+
// Replace with your project's Firebase info.
40+
var config = {
41+
apiKey: "<API_KEY>",
42+
authDomain: "<PROJECT_ID>.firebaseapp.com",
43+
databaseURL: "https://<DATABASE_NAME>.firebaseio.com",
44+
};
45+
46+
// Pass the config params to Remixer start method.
47+
remixer.start(config);
48+
```
49+
50+
- You can then toggle on/off sharing to the remote controller from within the Remixer overlay.
51+
52+
### 5. Add variables.
3253
Now you can add any desired variables and use the callback method to assign the `selectedValue` property.
3354

3455
```javascript

0 commit comments

Comments
 (0)