mirror of
https://github.com/expo/config-plugins.git
synced 2026-11-13 20:28:07 -10:00
docs: clarify readme
This commit is contained in:
1 parent
68cf1c07b2
commit
b5246338cb
1 file changed
+3
-24
@@ -2,6 +2,8 @@
|
||||
|
||||
Expo Config Plugin to auto configure [`android-jsc-intl`](https://www.npmjs.com/package/android-jsc-intl) when the native code is generated (`expo prebuild`).
|
||||
|
||||
Adding this plugin lets you use `Intl` in your Android app, without using Hermes.
|
||||
|
||||
## Expo installation
|
||||
|
||||
> Tested against Expo SDK 42
|
||||
@@ -11,7 +13,7 @@ This package cannot be used in the "Expo Go" app because [it requires custom nat
|
||||
- First install the package with yarn, npm, or [`expo install`](https://docs.expo.io/workflow/expo-cli/#expo-install).
|
||||
|
||||
```sh
|
||||
expo install android-jsc-intl @config-plugins/android-jsc-intl
|
||||
expo install @config-plugins/android-jsc-intl
|
||||
```
|
||||
|
||||
After installing this npm package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`:
|
||||
@@ -25,26 +27,3 @@ After installing this npm package, add the [config plugin](https://docs.expo.io/
|
||||
```
|
||||
|
||||
Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) guide.
|
||||
|
||||
## API
|
||||
|
||||
The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and `prebuild`) the native app. If no extra properties are added, defaults will be used.
|
||||
|
||||
- `foobar` (_boolean_): Does XYZ. Default `false`.
|
||||
|
||||
#### Example
|
||||
|
||||
```json
|
||||
{
|
||||
"expo": {
|
||||
"plugins": [
|
||||
[
|
||||
"@config-plugins/android-jsc-intl",
|
||||
{
|
||||
// props ...
|
||||
}
|
||||
]
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in new issue
Block a user