Skip to content

Update README.md #474

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2022
Merged

Update README.md #474

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ NOTE: This project is currently in development and is covered by Segment's [Firs
- [@segment/analytics-react-native ![circleci](#segmentanalytics-react-native-circlecicircleci-url)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Expo Installation](#expo-installation)
- [Permissions](#permissions)
- [Migrating](#migrating)
- [Usage](#usage)
Expand Down Expand Up @@ -45,12 +44,12 @@ NOTE: This project is currently in development and is covered by Segment's [Firs

## Installation

Install `@segment/analytics-react-native` and [`react-native-async-storage/async-storage`](https://github.com/react-native-async-storage/async-storage):
Install `@segment/analytics-react-native`, [`@segment/sovran-react-native`](https://github.com/segmentio/sovran-react-native) and [`react-native-async-storage/async-storage`](https://github.com/react-native-async-storage/async-storage):

```sh
yarn add @segment/analytics-react-native @react-native-async-storage/async-storage
yarn add @segment/analytics-react-native @segment/sovran-react-native @react-native-async-storage/async-storage
# or
npm install --save @segment/analytics-react-native @react-native-async-storage/async-storage
npm install --save @segment/analytics-react-native @segment/sovran-react-native @react-native-async-storage/async-storage
```

For iOS, install native modules with:
Expand All @@ -60,18 +59,11 @@ npx pod-install
```
⚠️ For Android, you will have to add some extra permissions to your `AndroidManifest.xml`.

### Expo Installation
### Expo

🚀 `@segment/analytics-react-native 2.0` is compatible with Expo's [Custom Dev Client](https://docs.expo.dev/clients/getting-started/) and [EAS builds](https://docs.expo.dev/build/introduction/) without any additional configuration. Destination Plugins that require native modules may require custom [Expo Config Plugins](https://docs.expo.dev/guides/config-plugins/).

Follow the installation steps listed above for standard React Native builds

Install [`@segment/sovran-react-native`](https://github.com/segmentio/sovran-react-native)

```sh
yarn add @segment/sovran-react-native
```

⚠️ `@segment/analytics-react-native 2.0` is not compatible with Expo's managed workflow.
### Permissions

<details>
Expand Down