Skip to content

Commit ab3beaf

Browse files
committed
Updated README with configuration example
1 parent f8c189f commit ab3beaf

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ We can pass _custom_ options with the `configure()` method by passing an object
102102
| option | type | Default Value | Description |
103103
|----------------|----------|-------------------------|----------------------------------------|
104104
| debug | bool | false | When set to true, Firestack will log messages to the console and fire `debug` events we can listen to in `js` |
105+
| bundleID | string | Default from app `[NSBundle mainBundle]` | The bundle ID for the app to be bundled with |
105106
| googleAppID | string | "" | The Google App ID that is used to uniquely identify an instance of an app. |
106107
| databaseURL | string | "" | The database root (i.e. https://my-app.firebaseio.com) |
107108
| deepLinkURLScheme | string | "" | URL scheme to set up durable deep link service |
@@ -112,6 +113,17 @@ We can pass _custom_ options with the `configure()` method by passing an object
112113
| clientID | string | "" | The OAuth2 client ID for iOS application used to authenticate Google Users for signing in with Google |
113114
| APIKey | string | "" | The secret iOS API key used for authenticating requests from our app |
114115

116+
For instance:
117+
118+
```javascript
119+
firestack.configure({
120+
debug: true,
121+
googleAppID: 'sticker-me'
122+
})
123+
.then(() => console.log("Project configured and ready to boot"));
124+
firestack.on('debug', msg => console.log('Received debug message', msg))
125+
```
126+
115127
In _most_ cases, you shouldn't need to overwrite these configuration options, but they are available to you if necessary.
116128

117129
## API documentation

0 commit comments

Comments
 (0)