README.md
1# ${packageName}
2
3${description}
4<!--- remove for interfaces --->
5
6# API documentation
7
8- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/${docName}.md)
9- [Documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/${docName}/)
10
11<!--- end remove for interfaces --->
12# Installation in managed Expo projects
13
14For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](#api-documentation). If you follow the link and there is no documentation available then this library is not yet usable within managed projects — it is likely to be included in an upcoming Expo SDK release.
15
16# Installation in bare React Native projects
17
18For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
19
20### Add the package to your npm dependencies
21
22```
23npm install ${packageName}
24```
25
26<!--- remove for no-ios --->
27### Configure for iOS
28
29Run `npx pod-install` after installing the npm package.
30
31<!--- end remove for no-ios --->
32
33<!--- remove for no-android --->
34### Configure for Android
35
36<!--- remove for interfaces --->
37
38<!--- remove for no-package --->
39No additional setup necessary.
40
41<!--- end remove for no-package --->
42<!--- end remove for interfaces --->
43<!--- end remove for no-android --->
44# Contributing
45
46Contributions are very welcome! Please refer to guidelines described in the [contributing guide]( https://github.com/expo/expo#contributing).
47