Skip to content

Commit b30b6b0

Browse files
authored
Merge pull request #67 from mixpanel/update-readme-tweak
Polish README
2 parents 9d50f0f + 6e3287e commit b30b6b0

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11

2+
23
<div align="center" style="text-align: center">
34
<img src="https://github.com/mixpanel/mixpanel-android/blob/assets/mixpanel.png?raw=true" alt="Mixpanel React Native Library" height="150"/>
45
</div>
@@ -9,8 +10,11 @@
910
<!-- MarkdownTOC -->
1011
- [Introduction](#introduction)
1112
- [Quick Start Guide](#quick-start-guide)
12-
- [Installation](#installation)
13-
- [Integration](#integration)
13+
- [Install Mixpanel](#install-mixpanel)
14+
- [Initialize Mixpanel](#initialize-mixpanel)
15+
- [Send Data](#send-data)
16+
- [Check for Success](#check-for-success)
17+
- [FAQ](#faq)
1418
- [I want to know more!](#i-want-to-know-more)
1519

1620
<!-- /MarkdownTOC -->
@@ -19,7 +23,7 @@
1923
## Introduction
2024
Welcome to the official Mixpanel React Native library.
2125
The Mixpanel React Native library is an open-source project, and we'd love to see your contributions!
22-
We'd also love for you to come and work with us! Check out **[Jobs](https://mixpanel.com/jobs/#openings)** for details
26+
We'd also love for you to come and work with us! Check out **[Jobs](https://mixpanel.com/jobs/#openings)** for details.
2327

2428
## Quick Start Guide
2529

@@ -31,10 +35,14 @@ Mixpanel's React Native SDK is a wrapper around Mixpanel’s native iOS and Andr
3135
- React Native v0.6+
3236
- [Setup development environment for React Native](https://reactnative.dev/docs/environment-setup)
3337
#### Steps
34-
1. Under your app's root directory, install Mixpanel React Native SDK
35-
```npm install mixpanel-react-native```
38+
1. Under your app's root directory, install Mixpanel React Native SDK.
39+
```
40+
npm install mixpanel-react-native
41+
```
3642
2. Under your application's ios folder, run
37-
```pod install```
43+
```
44+
pod install
45+
```
3846
Please note: You do not need to update your Podfile to add Mixpanel.
3947
3. For Xcode 12.5+, there is a known compile issue, please refer to this **[workaround](https://github.com/mixpanel/mixpanel-react-native/issues/43#issuecomment-829599732)**.
4048

@@ -57,7 +65,7 @@ class YourClass extends React.Component {
5765
```
5866
Once you've called this method once, you can access `mixpanel` throughout the rest of your application.
5967
### 3. Send Data
60-
Let's get started by sending event data. You can send an event from anywhere in your application. Better understand user behavior by storing details that are specific to the event (properties). After initializing the library, Mixpanel will [automatically collect common mobile events](https://mixpanel.com/help/questions/articles/which-common-mobile-events-can-mixpanel-collect-on-my-behalf-automatically). You can enable/disable automatic collection through your project settings. Also, Mixpanel automatically tracks some properties by default; [learn more](https://help.mixpanel.com/hc/en-us/articles/115004613766-Default-Properties-Collected-by-Mixpanel).
68+
Let's get started by sending event data. You can send an event from anywhere in your application. Better understand user behavior by storing details that are specific to the event (properties). After initializing the library, Mixpanel will [automatically collect common mobile events](https://mixpanel.com/help/questions/articles/which-common-mobile-events-can-mixpanel-collect-on-my-behalf-automatically). You can enable/disable automatic collection through your project settings. Also, Mixpanel automatically tracks some properties by default. [learn more](https://help.mixpanel.com/hc/en-us/articles/115004613766-Default-Properties-Collected-by-Mixpanel)
6169
```js
6270
// Track with event-name
6371
mixpanel.track('Sent Message');
@@ -82,14 +90,12 @@ To preserve battery life and customer bandwidth, the Mixpanel library doesn't se
8290
8391
```
8492
mixpanel.flush();
85-
8693
```
8794
8895
If your events are still not showing up after 60 seconds, check if you have opted out of tracking. You can also enable Mixpanel debugging and logging, it allows you to see the debug output from the Mixpanel library. To enable it, call [setLoggingEnabled](https://mixpanel.github.io/mixpanel-swift/Classes/MixpanelInstance.html#/s:8Mixpanel0A8InstanceC14loggingEnabledSbvp) to true, then run your iOS project with Xcode or android project with Android Studio. The logs should be available in the console.
8996
9097
```
9198
mixpanel.setLoggingEnabled(true);
92-
9399
```
94100
95101
**Starting with iOS 14.5, do I need to request the user’s permission through the AppTrackingTransparency framework to use Mixpanel?**

0 commit comments

Comments
 (0)