Skip to content

Commit 450f4d0

Browse files
committed
chore: add docs, video preview, images
Signed-off-by: Sam Gammon <[email protected]>
1 parent 9b8a0cc commit 450f4d0

File tree

5 files changed

+31
-1
lines changed

5 files changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
[Buildless][1], [Pkgst][8], [Turbo][2], and [React Native][3] with [sccache][4].
44

5+
> See [a video preview][13] of this sample on the command line
6+
7+
| Uncached build (**22 seconds**) | Cached build (**1.5 seconds**) |
8+
| -------------- | ------------ |
9+
| <img src="docs/build-cli-clean.png" alt="Clean build" /> | <img src="docs/build-cli-repeat.png" alt="Cached build"> |
10+
511

612
## Details about this sample
713

@@ -15,7 +21,7 @@ Together, these tools provide a unified cross-platform development environment,
1521
- [Turbo docs: Remote caching][9]
1622

1723

18-
## Using this example
24+
## Trying the sample
1925

2026
> **Before you start:** Obtain an API key for [Buildless][1], set it at `BUILDLESS_APIKEY` in your environment
2127
@@ -43,6 +49,21 @@ pnpm run android
4349
```
4450

4551

52+
## Using the sample for your own codebase
53+
54+
This is a [GitHub Template repository][10]; you can easily use it to create your own repo. Follow these steps to customize it
55+
for use with your Buildless account:
56+
57+
1) Update `.github/CODEOWNERS`
58+
2) Add a [GitHub Secret][11] called `BUILDLESS_APIKEY`, set to the API key you want to use in CI
59+
3) That's it!
60+
61+
62+
### Sharing an API key across an organization
63+
64+
You can use [Organization Secrets][12] to automatically provide a `BUILDLESS_APIKEY` to all your repos.
65+
66+
4667
## Docs from the original template
4768

4869
This template is a fork of [a similar Vercel-provided template][6]. The original README docs from that template are enclosed below.
@@ -69,6 +90,11 @@ This Turborepo has some additional tools already setup for you:
6990
- [Prettier](https://prettier.io) for code formatting
7091

7192

93+
## Video preview
94+
95+
[![asciicast](https://asciinema.org/a/608260.svg)](https://asciinema.org/a/608260)
96+
97+
7298
[1]: https://less.build
7399
[2]: https://turbo.build
74100
[3]: https://reactnative.dev
@@ -78,3 +104,7 @@ This Turborepo has some additional tools already setup for you:
78104
[7]: https://docs.less.build/docs/turborepo
79105
[8]: https://docs.less.build/docs/pkgst
80106
[9]: https://turbo.build/repo/docs/core-concepts/remote-caching
107+
[10]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
108+
[11]: https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions
109+
[12]: https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-an-organization
110+
[13]: https://asciinema.org/a/608260

docs/build-cli-clean.png

1.49 MB
Loading

docs/build-cli-repeat.png

1.47 MB
Loading

docs/secrets-org.png

47.6 KB
Loading

docs/secrets-repo.png

15.5 KB
Loading

0 commit comments

Comments
 (0)