aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/examples/with-react-native-web/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/with-react-native-web/README.md')
-rw-r--r--examples/with-react-native-web/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/examples/with-react-native-web/README.md b/examples/with-react-native-web/README.md
new file mode 100644
index 0000000..327ca66
--- /dev/null
+++ b/examples/with-react-native-web/README.md
@@ -0,0 +1,32 @@
+# Turborepo react-native starter
+
+This is an official starter Turborepo.
+
+## Using this example
+
+Run the following command:
+
+```sh
+npx create-turbo@latest -e with-react-native-web
+```
+
+## What's inside?
+
+This Turborepo includes the following packages/apps:
+
+### Apps and Packages
+
+- `native`: a [react-native](https://reactnative.dev/) app built with [expo](https://docs.expo.dev/)
+- `web`: a [Next.js](https://nextjs.org/) app built with [react-native-web](https://necolas.github.io/react-native-web/)
+- `ui`: a stub [react-native](https://reactnative.dev/) component library shared by both `web` and `native` applications
+- `tsconfig`: `tsconfig.json`s used throughout the monorepo
+
+Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
+
+### Utilities
+
+This Turborepo has some additional tools already setup for you:
+
+- [Expo](https://docs.expo.dev/) for native development
+- [TypeScript](https://www.typescriptlang.org/) for static type checking
+- [Prettier](https://prettier.io) for code formatting