nhagen / react-intercom

A component to configure and enable Intercom in your react application
MIT License
237 stars 72 forks source link

Incorrect documentation? #5

Closed olalonde closed 8 years ago

olalonde commented 8 years ago
<Intercom appID="az33rewf" userID={ user.id } otherUserProp={ user.otherUserProp } />

should be

<Intercom appID="az33rewf" settings={{ user_id: user.id, email: user.email, name: user.name }} />

Well, at least according to that line:

    window.intercomSettings = { ...props.settings, app_id: appID };

Right?

nhagen commented 8 years ago

Looks like I was hasty meging in a pull request that changed the API. That change shouldn't occur without a major version bump, and I'm not sure its necessary at this point. I've reverted the API change so that

<Intercom appID="az33rewf" userID={ user.id } otherUserProp={ user.otherUserProp } />

is correct again.

Thanks for pointing this out!

olalonde commented 8 years ago

Thanks.