Skip to content

Commit c9ca92c

Browse files
committed
Updated README.md with latest config status update
1 parent d737b36 commit c9ca92c

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,9 @@ Each platform uses a different setup method after creating the project.
173173

174174
After creating a Firebase project, click on the [Add Firebase to your iOS app](http://d.pr/i/3sEL.png) and follow the steps from there to add the configuration file. You do _not_ need to set up a cocoapods project (this is already done through firestack). Make sure not to forget the `Copy Files` phase in iOS.
175175

176-
[Download the Firebase config file](https://support.google.com/firebase/answer/7015592) (this step is optional, but prevents some ugly errors in the console).
176+
[Download the Firebase config file](https://support.google.com/firebase/answer/7015592) and place it in your app directory next to your app source code:
177+
178+
![GoogleService-Info.plist](http://d.pr/i/1eGev.png)
177179

178180
Once you download the configuration file, make sure you place it in the root of your Xcode project. Every different Bundle ID (aka, even different project variants needs their own configuration file).
179181

@@ -203,33 +205,18 @@ We can pass _custom_ options by passing an object with configuration options. Th
203205

204206
| option | type | Default Value | Description |
205207
|----------------|----------|-------------------------|----------------------------------------|
206-
| debug | bool | false | When set to true, Firestack will log messages to the console and fire `debug` events we can listen to in `js` |
207-
| bundleID | string | Default from app `[NSBundle mainBundle]` | The bundle ID for the app to be bundled with |
208-
| googleAppID | string | "" | The Google App ID that is used to uniquely identify an instance of an app. |
209-
| databaseURL | string | "" | The database root (i.e. https://my-app.firebaseio.com) |
210-
| deepLinkURLScheme | string | "" | URL scheme to set up durable deep link service |
211-
| storageBucket | string | "" | The Google Cloud storage bucket name |
212-
| androidClientID | string | "" | The Android client ID used in Google AppInvite when an iOS app has it's android version |
213-
| GCMSenderID | string | "" | The Project number from the Google Developer's console used to configure Google Cloud Messaging |
214-
| trackingID | string | "" | The tracking ID for Google Analytics |
215-
| clientID | string | "" | The OAuth2 client ID for iOS application used to authenticate Google Users for signing in with Google |
216-
| APIKey | string | "" | The secret iOS API key used for authenticating requests from our app |
208+
| debug | string/bool | false | When set to true, Firestack will log messages to the console and fire `debug` events we can listen to in `js` |
217209

218210
For instance:
219211

220212
```javascript
221213
const configurationOptions = {
222-
debug: true,
223-
googleAppID: 'sticker-me'
214+
debug: true
224215
};
225216
const firestack = new Firestack(configurationOptions);
226217
firestack.on('debug', msg => console.log('Received debug message', msg))
227218
```
228219

229-
In _most_ cases, you shouldn't need to overwrite these configuration options, but they are available to you if necessary.
230-
231-
**Options passed to the `Firestack` constructor take precedence over the native configuration to allow the JS to define custom variables on a per-platform basis**
232-
233220
## API documentation
234221

235222
Firestack is broken up into multiple parts, based upon the different API features that Firebase provides.
@@ -637,7 +624,7 @@ Firestack comes in with a built-in method for handling user connections. We just
637624
firestack.presence // the presence api
638625
.on('users/connections') // set the users/connections as the
639626
// root for presence handling
640-
.setOnlineFor('auser') // Set the child of auser as online
627+
.setOnline('auser') // Set the child of auser as online
641628
```
642629

643630
While the _device_ is online (the connection), the value of the child object at `users/connections/auser` will be:

0 commit comments

Comments
 (0)