aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/examples/non-monorepo/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/non-monorepo/README.md')
-rw-r--r--examples/non-monorepo/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/examples/non-monorepo/README.md b/examples/non-monorepo/README.md
new file mode 100644
index 0000000..ba2ecaf
--- /dev/null
+++ b/examples/non-monorepo/README.md
@@ -0,0 +1,42 @@
+# Turborepo non-monorepo starter
+
+This is an official starter Turborepo.
+
+## Using this example
+
+Run the following command:
+
+```sh
+npx create-turbo@latest -e non-monorepo
+```
+
+## What's inside?
+
+This Turborepo uses a single, non-monorepo project (in this case, a single Next.js application). Since [Turborepo 1.6](https://turbo.build/blog/turbo-1-6-0#any-codebase-can-use-turborepo), you can use Turborepo for non-monorepo projects as well as monorepos.
+
+### Build
+
+To build all apps and packages, run the following command:
+
+```
+pnpm turbo build
+```
+
+### Develop
+
+To develop all apps and packages, run the following command:
+
+```
+pnpm turbo dev
+```
+
+## Useful Links
+
+Learn more about the power of Turborepo:
+
+- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
+- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
+- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
+- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
+- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
+- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)