Skip to content

Commit 8bd6435

Browse files
committed
chore: update readme
Signed-off-by: Sam Gammon <sam@elide.ventures>
1 parent 7f0c212 commit 8bd6435

File tree

1 file changed

+54
-6
lines changed

1 file changed

+54
-6
lines changed

README.md

Lines changed: 54 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,53 @@
1-
# Turborepo react-native starter
1+
# turborepo + react native sample
2+
3+
[Buildless][1], [Pkgst][8], [Turbo][2], and [React Native][3] with [sccache][4].
4+
5+
6+
## Details about this sample
7+
8+
Together, these tools provide a unified cross-platform development environment, enabled with blazing-fast remote build caching. Turbo handles build caching for the web portion of the app. `sccache` kicks in for Swift builds.
9+
10+
11+
### Additional resources
12+
13+
- [Buildless docs: Turborepo setup][7]
14+
- [Swift docs: Using `sccache`][5]
15+
- [Turbo docs: Remote caching][9]
216

3-
This is an official starter Turborepo.
417

518
## Using this example
619

7-
Run the following command:
20+
> **Before you start:** Obtain an API key for [Buildless][1], set it at `BUILDLESS_APIKEY` in your environment
21+
22+
1) Clone the sample, install dependencies with `pnpm i`
23+
2) Run a build with `pnpm run build`; observe that Turbo uses Buildless
24+
3) Set up [`sccache`][4], and [link it to your Swift toolchain][5]
25+
4) Enjoy lightning-fast builds on all platforms
26+
27+
28+
### Building and running each app
29+
30+
> To run the web app:
31+
```
32+
pnpm run dev
33+
```
34+
35+
> To run the iOS app:
36+
```
37+
pnpm run ios
38+
```
839

9-
```sh
10-
npx create-turbo@latest -e with-react-native-web
40+
> To run the Android app:
41+
```
42+
pnpm run android
1143
```
1244

13-
## What's inside?
45+
46+
## Docs from the original template
47+
48+
This template is a fork of [a similar Vercel-provided template][6]. The original README docs from that template are enclosed below.
49+
50+
### What's inside?
1451

1552
This Turborepo includes the following packages/apps:
1653

@@ -30,3 +67,14 @@ This Turborepo has some additional tools already setup for you:
3067
- [Expo](https://docs.expo.dev/) for native development
3168
- [TypeScript](https://www.typescriptlang.org/) for static type checking
3269
- [Prettier](https://prettier.io) for code formatting
70+
71+
72+
[1]: https://less.build
73+
[2]: https://turbo.build
74+
[3]: https://reactnative.dev
75+
[4]: https://github.com/mozilla/sccache
76+
[5]: https://github.com/apple/swift/blob/main/docs/DevelopmentTips.md#use-sccache-to-cache-build-artifacts
77+
[6]: https://vercel.com/templates/next.js/turborepo-react-native
78+
[7]: https://docs.less.build/docs/turborepo
79+
[8]: https://docs.less.build/docs/pkgst
80+
[9]: https://turbo.build/repo/docs/core-concepts/remote-caching

0 commit comments

Comments
 (0)