re-org READMEs

vercel · Apr 10, 2023 · 18d9caa · 18d9caa
1 parent 0bfddba
commit 18d9caa
Show file tree

Hide file tree

Showing 15 changed files with 60 additions and 120 deletions.
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest
 ```
@@ -28,14 +32,6 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest
-```
-
 ### Build
 
 To build all apps and packages, run the following command:

diff --git a/examples/kitchen-sink/README.md b/examples/kitchen-sink/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo with multiple meta-frameworks all working in harmony and sharing packages.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e kitchen-sink
 ```
@@ -31,11 +35,3 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Jest](https://jestjs.io) test runner for all things JavaScript
 - [Prettier](https://prettier.io) for code formatting
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e kitchen-sink
-```
diff --git a/examples/non-monorepo/README.md b/examples/non-monorepo/README.md
@@ -2,14 +2,6 @@
 
 This is an official starter Turborepo.
 
-```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.
-
 ## Using this example
 
 Run the following command:
@@ -18,6 +10,10 @@ Run the following command:
 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:

diff --git a/examples/with-changesets/README.md b/examples/with-changesets/README.md
@@ -2,6 +2,10 @@
 
 This is an official React design system starter powered by Turborepo. Versioning and package publishing is handled by [Changesets](https://github.com/changesets/changesets) and fully automated with GitHub Actions.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-changesets
 ```
@@ -28,14 +32,6 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-changesets
-```
-
 ### Useful commands
 
 - `yarn build` - Build all packages and the docs site

diff --git a/examples/with-create-react-app/README.md b/examples/with-create-react-app/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-create-react-app
 ```
@@ -28,11 +32,3 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Jest](https://jestjs.io) test runner for all things JavaScript
 - [Prettier](https://prettier.io) for code formatting
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-create-react-app
-```
diff --git a/examples/with-docker/README.md b/examples/with-docker/README.md
@@ -2,6 +2,10 @@
 
 This is an official Docker starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-docker
 ```
@@ -23,14 +27,6 @@ This turborepo uses [Yarn](https://classic.yarnpkg.com/lang/en/) as a package ma
 
 Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-docker
-```
-
 ### Docker
 
 This repo is configured to be built with Docker, and Docker compose. To build all apps in this repo:

diff --git a/examples/with-gatsby/README.md b/examples/with-gatsby/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-gatsby
 ```
@@ -28,14 +32,6 @@ This turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-gatsby
-```
-
 ### Build
 
 To build all apps and packages, run the following command:

diff --git a/examples/with-npm/README.md b/examples/with-npm/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-npm
 ```
@@ -28,14 +32,6 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-npm
-```
-
 ### Build
 
 To build all apps and packages, run the following command:

diff --git a/examples/with-prisma/README.md b/examples/with-prisma/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-prisma
 ```
@@ -78,14 +82,6 @@ yarn run db:seed
 
 For further more information on migrations, seeding & more, we recommend reading through the [Prisma Documentation](https://www.prisma.io/docs/).
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-prisma
-```
-
 ### Build
 
 To build all apps and packages, run the following command:

diff --git a/examples/with-react-native-web/README.md b/examples/with-react-native-web/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-react-native-web
 ```
@@ -26,11 +30,3 @@ 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
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-react-native-web
-```
diff --git a/examples/with-rollup/README.md b/examples/with-rollup/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo, showing how Turborepo can be used with Rollup for bundling a `ui` package.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-rollup
 ```
@@ -27,14 +31,6 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-rollup
-```
-
 ### Build
 
 To build all apps and packages, run the following command:

diff --git a/examples/with-svelte/README.md b/examples/with-svelte/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-svelte
 ```
@@ -26,11 +30,3 @@ This Turborepo has some additional tools already setup for you:
 - [TypeScript](https://www.typescriptlang.org/) for static type checking
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-svelte
-```
diff --git a/examples/with-tailwind/README.md b/examples/with-tailwind/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-tailwind
 ```
@@ -45,11 +49,3 @@ This Turborepo has some additional tools already setup for you:
 - [TypeScript](https://www.typescriptlang.org/) for static type checking
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-tailwind
-```
diff --git a/examples/with-vite/README.md b/examples/with-vite/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-vite
 ```
@@ -28,11 +32,3 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Jest](https://jestjs.io) test runner for all things JavaScript
 - [Prettier](https://prettier.io) for code formatting
-
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-vite
-```
diff --git a/examples/with-yarn/README.md b/examples/with-yarn/README.md
@@ -2,6 +2,10 @@
 
 This is an official starter Turborepo.
 
+## Using this example
+
+Run the following command:
+
 ```sh
 npx create-turbo@latest -e with-yarn
 ```
@@ -28,14 +32,6 @@ This Turborepo has some additional tools already setup for you:
 - [ESLint](https://eslint.org/) for code linting
 - [Prettier](https://prettier.io) for code formatting
 
-## Using this example
-
-Run the following command:
-
-```sh
-npx create-turbo@latest -e with-yarn
-```
-
 ### Build
 
 To build all apps and packages, run the following command: