You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,12 @@ Install using Meteor:
24
24
$ meteor add mizzao:user-status
25
25
```
26
26
27
+
### Compatibility
28
+
29
+
The `2.0.0` release candidates target Meteor 3.0 and newer, and use the stable
30
+
`mizzao:timesync@1.0.0` package. Meteor 2.x applications should stay on the
31
+
`1.x` line of this package until the application is ready to migrate to Meteor 3.
32
+
27
33
Additionally, note that to read client IP addresses properly, you must set the
28
34
`HTTP_FORWARDED_COUNT` environment variable for your app, and make sure that IP
29
35
address headers are forwarded for any reverse proxy installed in front of the
@@ -117,7 +123,9 @@ The `UserStatus.connections` (in-memory) collection contains information for all
117
123
118
124
#### startupQuerySelector (Optional)
119
125
120
-
On startup `meteor-user-status` automatically resets all users to `offline` and then marks each `online` as connections are reestablished.
126
+
On startup `meteor-user-status` automatically resets online users to `offline`
127
+
using the default selector `{ "status.online": true }`, then marks users
128
+
`online` again as connections are reestablished.
121
129
122
130
To customize this functionality you can use the `startupQuerySelector`[Meteor package option](https://docs.meteor.com/api/packagejs.html#options) like this:
123
131
```javascript
@@ -199,8 +207,9 @@ The `UserStatus.events` object is an `EventEmitter` on which you can listen for
199
207
Check out https://github.com/mizzao/meteor-accounts-testing for a simple accounts drop-in that you can use to test your app - this is also used in the demo.
200
208
201
209
#### Startup selector
202
-
By default, the startup selector for resetting user status is `{}`.
203
-
If you want to change that you can set the default selector in your settings.json file:
210
+
By default, the startup selector for resetting user status is
211
+
`{ "status.online": true }`. If you want to change that you can set the default
0 commit comments