docs(metro-config): add Expo example (#3274)

microsoft · Aug 12, 2024 · 9c653cc · 9c653cc
1 parent 98bf1c0
commit 9c653cc
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.changeset/curvy-rockets-hammer.md b/.changeset/curvy-rockets-hammer.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/metro-config/README.md b/packages/metro-config/README.md
@@ -41,6 +41,20 @@ module.exports = makeMetroConfig({
 `makeMetroConfig` takes a Metro config as parameter. The config is augmented
 with additional fields to make sure it works smoothly in a monorepo.
 
+### Expo
+
+`@rnx-kit/metro-config` can be used with Expo. Pass its default config to
+`makeMetroConfig` like below:
+
+```js
+// metro.config.js
+const { getDefaultConfig } = require("@expo/metro-config");
+const { makeMetroConfig } = require("@rnx-kit/metro-config");
+
+const config = getDefaultConfig(__dirname);
+module.exports = makeMetroConfig(config);
+```
+
 ## Known Limitations
 
 While Metro is the de-facto standard, it lacks a few features that would make it