Skip to content

Commit e7bb4f9

Browse files
committed
docs: ✏️ update readme
1 parent 1d6c0f2 commit e7bb4f9

File tree

1 file changed

+3
-49
lines changed

1 file changed

+3
-49
lines changed

README.md

+3-49
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,12 @@
1-
# Turborepo Tailwind CSS 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 -e with-tailwind
11-
```
1+
# Smart Token List
122

133
## What's inside?
144

155
This Turborepo includes the following packages/apps:
166

177
### Apps and Packages
188

19-
- `docs`: a [Next.js](https://nextjs.org/) app with [Tailwind CSS](https://tailwindcss.com/)
20-
- `web`: another [Next.js](https://nextjs.org/) app with [Tailwind CSS](https://tailwindcss.com/)
21-
- `ui`: a stub React component library with [Tailwind CSS](https://tailwindcss.com/) 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
9+
- `@repo/smart-token-list`: List of Smart Tokens
10+
- `web`: Website
2411

2512
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
26-
27-
### Building packages/ui
28-
29-
This example is set up to produce compiled styles for `ui` components into the `dist` directory. The component `.tsx` files are consumed by the Next.js apps directly using `transpilePackages` in `next.config.js`. This was chosen for several reasons:
30-
31-
- Make sharing one `tailwind.config.js` to apps and packages as easy as possible.
32-
- Make package compilation simple by only depending on the Next.js Compiler and `tailwindcss`.
33-
- Ensure Tailwind classes do not overwrite each other. The `ui` package uses a `ui-` prefix for it's classes.
34-
- Maintain clear package export boundaries.
35-
36-
Another option is to consume `packages/ui` directly from source without building. If using this option, you will need to update the `tailwind.config.js` in your apps to be aware of your package locations, so it can find all usages of the `tailwindcss` class names for CSS compilation.
37-
38-
For example, in [tailwind.config.js](packages/tailwind-config/tailwind.config.js):
39-
40-
```js
41-
content: [
42-
// app content
43-
`src/**/*.{js,ts,jsx,tsx}`,
44-
// include packages if not transpiling
45-
"../../packages/ui/*.{js,ts,jsx,tsx}",
46-
],
47-
```
48-
49-
If you choose this strategy, you can remove the `tailwindcss` and `autoprefixer` dependencies from the `ui` package.
50-
51-
### Utilities
52-
53-
This Turborepo has some additional tools already setup for you:
54-
55-
- [Tailwind CSS](https://tailwindcss.com/) for styles
56-
- [TypeScript](https://www.typescriptlang.org/) for static type checking
57-
- [ESLint](https://eslint.org/) for code linting
58-
- [Prettier](https://prettier.io) for code formatting

0 commit comments

Comments
 (0)