Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds info to readme on intercom integration #12

Closed
wants to merge 3 commits into from

Conversation

Projects
None yet
2 participants
@zanuka
Copy link

zanuka commented Apr 1, 2019

@v3rm0n I was able to get your package running in our flutter app, nice work 馃挴
I thought it might be helpful to add some more info to the example readme and provide some links to the intercom docs.

## Getting Started
## initialize & identify user

see example code at [lib/main.dart](lib/main.dart)

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

Sentences should be capitalized

This comment has been minimized.

Copy link
@zanuka

zanuka Apr 1, 2019

Author

@Zazo032 I've updated the branch to address your comments.


configure your app's main function as follows

void main() async {

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

Wrap code blocks using Markdown's code formatter to properly format it.

  1. Add ```dart before the code block
  2. Insert the code block
  3. Add ``` after the code block

This comment has been minimized.

Copy link
@zanuka

zanuka Apr 1, 2019

Author

using the generic tab indents is just old habit... definitely looks better with the dart syntax highlighting

child: Text('Open Intercom'),
onPressed: () async {
await Intercom.displayMessenger();
}),

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

Missing trailing comma after the }

This comment has been minimized.

Copy link
@zanuka

zanuka Apr 1, 2019

Author

fixed


[intercom ios installation docs](https://developers.intercom.com/installing-intercom/docs/ios-installation)

[intercom android installation docs](https://developers.intercom.com/installing-intercom/docs/android-installation)

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

Add capitalization here too (also, iOS and Android)

This comment has been minimized.

Copy link
@zanuka

zanuka Apr 1, 2019

Author

updated

androidApiKey: 'androidApiKey', iosApiKey: 'iosApiKey');

await Intercom.registerIdentifiedUser(email: 'your_intercom_user@domain.com');
// you can also use intercom user name instead of email

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

The correct way is using the userId or the email parameter, not the username

This comment has been minimized.

Copy link
@zanuka

zanuka Apr 1, 2019

Author

fixed


[iOS Installation](https://developers.intercom.com/installing-intercom/docs/ios-installation)

[Android Installation](https://developers.intercom.com/installing-intercom/docs/android-installation)

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

installation in lowercase looks better IMO


See example code at [lib/main.dart](lib/main.dart)

configure your app's main function as follows

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

Capitalization

## Display Intercom Messenger from Flutter UI Element

```dart
new FlatButton(

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

new is no longer required in Dart

This comment has been minimized.

Copy link
@zanuka

zanuka Apr 1, 2019

Author

Yes I know this, was referencing the example code in your repo.

onPressed: () {
Intercom.displayMessenger();
},
child: Text('Show messenger')),

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

Missing , for better formatting (between both parenthesis)

await Intercom.registerIdentifiedUser(email: 'user_email@example.com');
// you can also use the userId instead of email address
// await Intercom.registerIdentifiedUser(userId: 'intercomUserID');

This comment has been minimized.

Copy link
@Zazo032

Zazo032 Apr 1, 2019

Contributor

In Dart, we usually wrap variables between [] (like userId or email) and use /// for documentation

@zanuka

This comment has been minimized.

Copy link
Author

zanuka commented Apr 1, 2019

closing this, as it isn't really necessary... code works fine, I was just suggesting to add some info to readme.

@zanuka zanuka closed this Apr 1, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.