Skip to content

Commit

Permalink
[packages] Update README to clarify difference in installation steps …
Browse files Browse the repository at this point in the history
…between managed and bare projects
  • Loading branch information
brentvatne committed Sep 12, 2019
1 parent b11ae8b commit 18adec1
Show file tree
Hide file tree
Showing 61 changed files with 244 additions and 122 deletions.
6 changes: 4 additions & 2 deletions packages/expo-ads-admob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Provides support for the Google AdMob SDK (https://www.google.com/admob/) for mo
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/admob.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/admob/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-ads-facebook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Facebook Audience SDK integration
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/facebook-ads.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/facebook-ads/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-analytics-amplitude/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Provides access to Amplitude (https://amplitude.com/) mobile analytics. This mod
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/amplitude.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/amplitude/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-analytics-segment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Expo module that provides access to Segment mobile analytics
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/segment.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/segment/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-app-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Provides an interface with the OpenID library AppAuth
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/app-auth.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/app-auth/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-app-loader-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

Provides application loaders

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-apple-authentication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ This library provides Apple authentication for iOS standalone apps in the manage
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/apple-authentication.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/apple-authentication/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-application/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ Gets native application information such as its ID, app name, and build version

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/application.md)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-asset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ An Expo universal module to download assets and pass them into other APIs
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/asset.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/asset/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-av/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Expo universal module for Audio and Video playback
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/av.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/av/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-background-fetch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Expo universal module for BackgroundFetch API
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/background-fetch.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/background-fetch/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-barcode-scanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Allows scanning variety of supported barcodes both as standalone module and as e
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/bar-code-scanner.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/bar-code-scanner/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-battery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ Provide battery information for the physical device.

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/battery.md)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-blur/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ A component that renders a native blur view on iOS and falls back to a semi-tran
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/blur-view.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/blur-view/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-brightness/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Provides an API to get and set screen brightness.
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/brightness.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/brightness/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-calendar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Provides an API for interacting with the device's system calendars, events, remi
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/calendar.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/calendar/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-camera/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ A React component that renders a preview for the device's either front or back c
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/camera.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/camera/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-cellular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ Information about the user’s cellular service provider, such as its unique ide

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/cellular.md)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
6 changes: 4 additions & 2 deletions packages/expo-constants/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Provides system information that remains constant throughout the lifetime of you
- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/constants.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/constants/)

# Installation
# Installation in managed Expo projects

This package is pre-installed in [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects. You may skip the rest of the installation guide if this applies to you.
For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation).

# Installation in bare React Native projects

For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/unimodules/react-native-unimodules) before continuing.

Expand Down
Loading

0 comments on commit 18adec1

Please sign in to comment.