You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-5Lines changed: 4 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ The Material-UI CLI is a powerful command-line interface tool designed to signif
34
34
## 📦 Installation
35
35
36
36
```sh
37
-
npm install -g mui-cli
37
+
npm i -g material-cli
38
38
```
39
39
40
40
## 🚀 Usage
@@ -44,7 +44,7 @@ npm install -g mui-cli
44
44
To initialize a new project, first, navigate to the desired folder, then:
45
45
46
46
```sh
47
-
mui-cli project-init [options]
47
+
material-cli project-init [options]
48
48
```
49
49
50
50
The available options for the initialization command are:
@@ -72,7 +72,6 @@ If everything proceeded smoothly, you'll receive a confirmation message indicati
72
72
73
73
#### The downside of using MUI CLI to initialize your project includes:
74
74
75
-
- ⚠️ It relies on **CRA (Create React App)**, which might be a drawback for those intending to use other tools like **Vite**.
76
75
- ⚠️ The scaffolded MUI components are written in **JavaScript**, which could be a downside for those using **TypeScript**.
77
76
78
77
The MUI CLI team is actively exploring the best ways to address these issues promptly to facilitate smoother development.
@@ -82,7 +81,7 @@ The MUI CLI team is actively exploring the best ways to address these issues pro
82
81
Ensuring adherence to the correct MUI theming guidelines can sometimes be challenging. With MUI CLI, you can effortlessly generate a theme file that you can then customize to your preferences. To generate a `theme` file for your existing project, simply execute the following command:
83
82
84
83
```sh
85
-
mui-cli theme-init [options]
84
+
material-cli theme-init [options]
86
85
```
87
86
88
87
The following **options** can be passed to the command:
@@ -104,7 +103,7 @@ The `theme.js` file will be generated under `src > Theme` folder in your project
104
103
You can easily inspect your theme file to identify any potential errors or warnings that might have been overlooked. To inspect your theme file, simply execute the following command:
105
104
106
105
```sh
107
-
mui-cli theme-validate [options]
106
+
material-cli theme-validate [options]
108
107
```
109
108
110
109
The following **options** can be passes to the command:
0 commit comments