Skip to content

Commit 79429e9

Browse files
committed
read me installation npm
1 parent 8ad8037 commit 79429e9

File tree

2 files changed

+37
-7
lines changed

2 files changed

+37
-7
lines changed

packages/cli/README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
`@kodiui/cli` is a command-line interface (CLI) tool designed to facilitate the seamless integration of Kodi UI's primitive components into your projects. Drawing inspiration from the "Every Layout CSS" book, Kodi UI is meticulously crafted with Tailwind CSS, offering you a robust collection of versatile and aesthetically pleasing components that adapt effortlessly to your design needs.
1+
@kodiui/cli is a command-line interface (CLI) tool designed to effortlessly integrate Kodi UI's primitive components into your React projects. Drawing inspiration from the "Every Layout CSS" book, Kodi UI is meticulously crafted with Tailwind CSS, providing you with a robust collection of versatile and aesthetically pleasing components that adapt seamlessly to your design needs. With the @kodiui/cli, you can easily install desired components into your project, and have the flexibility to edit and customize them according to your specific requirements, ensuring a perfect fit for your application's design and functionality.
22

33
## Available Components 🛠
44

@@ -37,11 +37,44 @@
3737
9. **switcher.tsx** 🔀
3838
- A flexible component that enables seamless switching between different views or content.
3939

40-
run script
40+
## Getting Started 🚀
4141

42-
```
42+
To incorporate Kodi UI's primitive components into your project, simply follow these steps:
43+
44+
1. **Install the Components**
45+
46+
Run the following command to launch the CLI and install the primitive components:
4347

48+
```
4449
npx @kodiui/cli@latest
4550
```
4651

47-
By leveraging `@kodiui/cli`, you can effortlessly incorporate these primitive components into your project, ultimately saving you time and effort, and allowing you to focus more on crafting stunning, responsive user interfaces that make a lasting impression. 😊
52+
When prompted, select "Install Primitives".
53+
54+
2. **Configure Tailwind CSS**
55+
56+
After installation, you'll need to integrate the spacing token into your Tailwind CSS configuration. Open your Tailwind config file and include the spacing token like so:
57+
58+
```javascript
59+
// tailwind.config.js
60+
61+
import type { Config } from "tailwindcss";
62+
import { spacing } from "@/components/primitives/tokens/spacing";
63+
64+
const config: Config = {
65+
content: [
66+
// ... (your other content paths)
67+
],
68+
theme: {
69+
// ...
70+
extend: {
71+
// ...
72+
spacing: spacing,
73+
},
74+
},
75+
};
76+
77+
export default config;
78+
```
79+
80+
And that's it! You're now ready to harness the power of Kodi UI's primitive components in your React project. Enjoy crafting beautiful, responsive layouts with ease!

packages/cli/package.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
"keywords": [
2020
"kodiui",
2121
"cli",
22-
"component library",
2322
"tailwind",
2423
"css",
2524
"layout",
@@ -28,9 +27,7 @@
2827
"ui",
2928
"user interface",
3029
"responsive design",
31-
"flexbox",
3230
"every layout css",
33-
"frontend",
3431
"typescript"
3532
],
3633
"author": "dinoDanic",

0 commit comments

Comments
 (0)