Skip to content

Commit 5f6abe9

Browse files
committedOct 31, 2024
docs : rewrite readme
1 parent b3dde0b commit 5f6abe9

File tree

1 file changed

+18
-32
lines changed

1 file changed

+18
-32
lines changed
 

‎README.md

+18-32
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,23 @@
1-
# Tailus.io: V2
1+
# Reusable Tailwind Component classes
22

3-
Easy to customize UI components, blocks and templates built on top of modern frontend tools to make ideas stand out.
4-
5-
Before you start, run the following command to install and run the project:
3+
Free up your time with pre-built classes that update site-wide automatically. Focus on building, not fixing.
64

75
```bash
8-
npm install
9-
npm run dev
6+
pnpm install
7+
pnpm dev
108
```
119

1210
![github follow](https://img.shields.io/github/followers/Tailus-UI?style=social)
1311
[![Open github repo](https://img.shields.io/badge/github-open-blue?style=flat)](https://github.com/Tailus-UI/)
14-
[![Open the website](https://img.shields.io/badge/website-open-blue?style=flat)](https://tailus.io/)
12+
[![Open the website](https://img.shields.io/badge/website-open-blue?style=flat)](https://html.tailus.io/)
1513
[![twiter follow](https://img.shields.io/twitter/follow/tailusui?style=social)](https://twitter.com/tailus_ui)
1614
[![linkedin follow](https://img.shields.io/badge/linkedin-follow-blue?style=flat)](https://www.linkedin.com/company/tailus-ui/)
1715

18-
## 🚀 Project Structure
19-
20-
In the project, you'll see the following folders and files:
21-
22-
```structure
23-
/
24-
├── public/
25-
│ └── favicon.svg
26-
├── src/
27-
│ ├── components/
28-
│ │ └── Card.astro
29-
│ ├── layouts/
30-
│ │ └── Layout.astro
31-
│ └── pages/
32-
│ └── index.astro
33-
└── package.json
34-
```
16+
## Documentation
17+
18+
[Docs](https://html.tailus.io/get-started/installation)
19+
20+
## Project Structure
3521

3622
The project is built with Astro, which searches for `.astro` or `.md` files in the `src/pages/` directory. Each page is displayed as a route based on its file name.
3723

@@ -43,11 +29,11 @@ Any static assets, like images, can be placed in the `public/` directory.
4329

4430
All commands are run from the root of the project, from a terminal:
4531

46-
| Command | Action |
47-
| :------------------------ | :----------------------------------------------- |
48-
| `npm install` | Installs dependencies |
49-
| `npm run dev` | Starts local dev server at `localhost:3000` |
50-
| `npm run build` | Build your production site to `./dist/` |
51-
| `npm run preview` | Preview your build locally, before deploying |
52-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
53-
| `npm run astro -- --help` | Get help using the Astro CLI |
32+
| Command | Action |
33+
| :----------------------| :----------------------------------------------- |
34+
| `pnpm install` | Installs dependencies |
35+
| `pnpm dev` | Starts local dev server at `localhost:3000` |
36+
| `pnpm build` | Build your production site to `./dist/` |
37+
| `pnpm preview` | Preview your build locally, before deploying |
38+
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
39+
| `pnpm astro -- --help` | Get help using the Astro CLI |

0 commit comments

Comments
 (0)