Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

Commit 5625066

Browse files
committed
Add installation instructions
1 parent 5a7701b commit 5625066

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ This is a collection of UI components created in Nuxt 3.
99
#### NOTICE:
1010
This is under development.
1111
Changes will occur and the project is still in early stages of development.
12-
- <b>Main</b> branch contains the latest "stable" changes.
13-
- <b>Dev</b> branch contains the "unstable" changes.
1412

1513
## Why did I create this?
1614

@@ -23,10 +21,25 @@ Now I just want the same experience in Nuxt.
2321

2422
## How does this work?
2523

26-
In your own project:
24+
First you need to install these dependencies:
2725

28-
1. Make sure you have tailwind installed. [Guide](https://nuxt.com/modules/tailwindcss).
29-
2. Next you need to install tailwind-variants. [Guide](https://www.tailwind-variants.org/docs/getting-started).
26+
```bash
27+
# npm
28+
npm install tailwindcss tailwind-variants
29+
npm install --save-dev nuxt-icon @hypernym/nuxt-anime
3030

31-
Now in this repositories [components/UI](components/UI/) folder you can find a bunch of UI components.
32-
Copy the ones you want into your own project and start playing with them.
31+
# yarn
32+
yarn add tailwindcss tailwind-variants
33+
yarn add --dev nuxt-icon @hypernym/nuxt-anime
34+
35+
# pnpm
36+
pnpm add tailwindcss tailwind-variants
37+
pnpm add -D nuxt-icon @hypernym/nuxt-anime
38+
```
39+
40+
I suggest reading a bit more about tailwind-variants and how it works from here [Guide](https://www.tailwind-variants.org/docs/getting-started).
41+
42+
After that you need to copy everything from these folders to you own project:
43+
- [ui-components](ui-components). Move to your components folder, or take example from nuxt.config.ts.
44+
- [plugins](plugins)
45+
- [composables](composables)

0 commit comments

Comments
 (0)