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

Commit

Permalink
Adds Firebase configuration documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
chriscox authored Mar 22, 2017
1 parent 095254e commit da41011
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,28 @@ This will install the Remixer files in your project's `node_modules` folder.
remixer.start();
```

### 4. Add variables.
### 4. (Optional) Configure the Web Remote Controller

This **optional** step is only needed if you wish to use the Web Remote Controller. If so, follow these guidelines:

- 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.
- Add your Firebase account credentials to your app, and forward the param to the `remixer.start()` method.

```javascript
// Replace with your project's Firebase info.
var config = {
apiKey: "<API_KEY>",
authDomain: "<PROJECT_ID>.firebaseapp.com",
databaseURL: "https://<DATABASE_NAME>.firebaseio.com",
};

// Pass the config params to Remixer start method.
remixer.start(config);
```

- You can then toggle on/off sharing to the remote controller from within the Remixer overlay.

### 5. Add variables.
Now you can add any desired variables and use the callback method to assign the `selectedValue` property.

```javascript
Expand Down

0 comments on commit da41011

Please sign in to comment.