Skip to content

Commit fb3b6cf

Browse files
committed
docs: initial readme docs
1 parent 9f6ebd3 commit fb3b6cf

File tree

2 files changed

+8
-81
lines changed

2 files changed

+8
-81
lines changed

README.md

+1-81
Original file line numberDiff line numberDiff line change
@@ -1,81 +1 @@
1-
# Turborepo starter
2-
3-
This is an official starter Turborepo.
4-
5-
## Using this example
6-
7-
Run the following command:
8-
9-
```sh
10-
npx create-turbo@latest
11-
```
12-
13-
## What's inside?
14-
15-
This Turborepo includes the following packages/apps:
16-
17-
### Apps and Packages
18-
19-
- `docs`: a [Next.js](https://nextjs.org/) app
20-
- `web`: another [Next.js](https://nextjs.org/) app
21-
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
22-
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
23-
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
24-
25-
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
26-
27-
### Utilities
28-
29-
This Turborepo has some additional tools already setup for you:
30-
31-
- [TypeScript](https://www.typescriptlang.org/) for static type checking
32-
- [ESLint](https://eslint.org/) for code linting
33-
- [Prettier](https://prettier.io) for code formatting
34-
35-
### Build
36-
37-
To build all apps and packages, run the following command:
38-
39-
```
40-
cd my-turborepo
41-
pnpm build
42-
```
43-
44-
### Develop
45-
46-
To develop all apps and packages, run the following command:
47-
48-
```
49-
cd my-turborepo
50-
pnpm dev
51-
```
52-
53-
### Remote Caching
54-
55-
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
56-
57-
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:
58-
59-
```
60-
cd my-turborepo
61-
npx turbo login
62-
```
63-
64-
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
65-
66-
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
67-
68-
```
69-
npx turbo link
70-
```
71-
72-
## Useful Links
73-
74-
Learn more about the power of Turborepo:
75-
76-
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
77-
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
78-
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
79-
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
80-
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
81-
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
1+
packages/library/README.md

library/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## 🌱 Features
2+
3+
- [x] 🍂 Lightweight.
4+
- [x] 🎨 Light/dark mode.
5+
- [x] ⏲️ Don't close automatically when the user hover over the toast.
6+
- [x] 🏗️ Customizable toast position.
7+
- [x] ✅ Accessible.

0 commit comments

Comments
 (0)