Skip to content

Commit 700dbf0

Browse files
committed
Update README
1 parent 3091b22 commit 700dbf0

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Expo Config Plugins
22

3-
- A collection of [Expo config plugins](https://docs.expo.dev/guides/config-plugins/) for configuring the `npx expo prebuild` command.
4-
- This repo is to Expo config plugins as [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) is to TypeScript.
5-
- We prefer packages ship their own Expo config plugin (to ensure versioning is aligned), but if they haven't adopted the system yet, the community can add a package here.
6-
- All packages here are community maintained. Feel free to improve docs, packages, tests, etc.
3+
This repository is a collection of assorted [Expo config plugins](https://docs.expo.dev/guides/config-plugins/) for configuring the `npx expo prebuild` command.
4+
5+
- **We prefer packages ship their own Expo config plugin**. This helps to ensure that plugin and package versions are always aligned, and that features made available in the packages are made available at the same time in the plugin. If packages haven't adopted config plugins yet, the community can add a package here as a temporary home.
6+
7+
- **All packages here are community maintained.** - they are not maintained by Expo. Feel free to improve docs, packages, tests, etc.
8+
79
- We maintain a 1-1 mapping of **native packages**`@config-plugins/*`. This means there should be no general utility packages here -- those are better suited for a different repo / NPM namespace.
810

911
## First-party plugins
1012

11-
Here is a list of known packages that have a built-in Config Plugin.
12-
13-
> Not all packages need a config plugin, packages that don't appear here might still work with managed EAS.
13+
The following are some examples of libraries that have a built-in Config Plugin. This is far from an exhaustive list, and most React Native libraries have a built-in Config Plugin if one is needed (in many cases, it is not required).
1414

1515
- [React Native Firebase](https://rnfirebase.io/) (`@react-native-firebase/perf`, `@react-native-firebase/app`, `@react-native-firebase/crashlytics`)
1616
- [react-native-google-cast](https://github.com/react-native-google-cast/react-native-google-cast)
@@ -33,10 +33,11 @@ Here is a list of known packages that have a built-in Config Plugin.
3333
- [App Clips](https://github.com/bndkt/react-native-app-clip/)
3434
- [iOS Safari Extensions](https://github.com/andrew-levy/react-native-safari-extension/)
3535
- [react-native-ble-plx](https://github.com/dotintent/react-native-ble-plx)
36+
- ... and [many more](https://reactnative.directory/)
3637

3738
### Complementary
3839

39-
More out-of-tree plugins which can be used to configure more packages.
40+
In some cases, libraries will ship plugins as separate packages. For example:
4041

4142
- [onesignal-expo-plugin](https://github.com/OneSignal/onesignal-expo-plugin) (for use with `react-native-onesignal`)
4243
- Configures **iOS Notification Service Extensions** for rich push notification and custom notification actions.
@@ -50,6 +51,7 @@ More out-of-tree plugins which can be used to configure more packages.
5051
- [expo-react-native-freshchat](https://www.npmjs.com/package/expo-react-native-freshchat) (for use with `react-native-freshchat-sdk`)
5152
- [react-native-keyevent-expo-config-plugin](https://github.com/chronsyn/react-native-keyevent-expo-config-plugin) (for use with `react-native-keyevent`)
5253
- [watermelondb-expo-plugin](https://github.com/morrowdigital/watermelondb-expo-plugin) (for use with `@nozbe/watermelondb`)
54+
- ... and [many more](https://reactnative.directory/)
5355

5456
### No Plugin Required
5557

@@ -61,8 +63,7 @@ Just install and rebuild! If a package doesn't require any futher setup then it
6163
- [react-native-app-shortcuts](https://github.com/lokyoung/react-native-app-shortcuts)
6264
- [react-native-multiple-image-picker](https://github.com/baronha/react-native-multiple-image-picker)
6365
- [`@shopify/flash-list`](https://github.com/Shopify/flash-list)
64-
65-
> Feel free to [open a PR](https://github.com/expo/config-plugins/edit/main/README.md) with missing packages.
66+
- ... and [many more](https://reactnative.directory/)
6667

6768
## Contributing!
6869

0 commit comments

Comments
 (0)