@progress/kendo-cli 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -26,21 +26,22 @@ npx kendo react create nextjs MyKendoApp --ts --no-app
26
26
  ### Options
27
27
 
28
28
  Language options:
29
- - `--js` - Use JavaScript (default)
30
- - `--ts` - Use TypeScript
29
+
30
+ - `--js` - Use JavaScript (default)
31
+ - `--ts` - Use TypeScript
31
32
 
32
33
  Theme options:
33
34
 
34
- - `--theme=default`
35
- - `--theme=bootstrap`
36
- - `--theme=material`
35
+ - `--theme=default`
36
+ - `--theme=bootstrap`
37
+ - `--theme=material`
37
38
 
38
39
  Other:
39
40
 
40
- - `--eslint` - Initialize with eslint config.
41
- - `--no-app` - Initialize as **no** App Router project.
42
- - `--no-src-dir` - Initialize without a `src/` directory.
43
- - `--import-alias="@/*"` - Specify import alias to use.
41
+ - `--eslint` - Initialize with eslint config.
42
+ - `--no-app` - Initialize as **no** App Router project.
43
+ - `--no-src-dir` - Initialize without a `src/` directory.
44
+ - `--import-alias="@/*"` - Specify import alias to use.
44
45
 
45
46
  ### Build and Run
46
47
 
@@ -85,8 +86,100 @@ Options:
85
86
  [string] [choices: "default", "bootstrap", "material"] [default: "default"]
86
87
  ```
87
88
 
89
+ ## Kendo jQuery Project Generator
90
+
91
+ To use ***Kendo UI for jQuery*** and create a new ***jQuery*** project using ***our new project templates***:
92
+
93
+ 1. ***Blank Template*** - A simple ASP.NET MVC project with no pages with included Kendo UI for jQuery scripts and stylesheets.
94
+
95
+ ``` bash
96
+ # Create Kendo UI for jQuery app with Blank Template
97
+ npx kendo jquery create jba MyjQueryBlankApp
98
+ ```
99
+
100
+ 2. ***Admin Template*** - A complex ASP.NET MVC application with multiple views which include a Task Dashboard, Products and Performance statistics as well as an Account Settings page (back-end is not included). The project showcases many Kendo UI for jQuery components, including Grid, Charts, and many navigational components.
101
+
102
+ ```bash
103
+ # Create Kendo UI for jQuery app with Admin Template
104
+ npx kendo jquery create jqa MyjQueryAdminApp
105
+ ```
106
+
107
+ 3. ***Dashboard Template** - An ASP.NET MVC project which mocks a Team Efficiency report, with a ListView component that contains team members, and a Scheduler and Chart components that represent task and performance information.
108
+
109
+ ```bash
110
+ # Create Kendo UI for jQuery app with Dashboard Template
111
+ npx kendo jquery create jda MyjQueryDashboardApp
112
+ ```
113
+
114
+ 4. ***Dashboard Layout Template** - An ASP.NET MVC project that represents various data displayed through multiple Chart components, which are placed in a TileLayout.
115
+
116
+ ```bash
117
+ # Create Kendo UI for jQuery app with Dashboard Layout Template
118
+ npx kendo jquery create jdla MyjQueryDashboardLayoutApp
119
+ ```
120
+
121
+ 5. ***Grid Template*** - An ASP.NET MVC project that demonstrates a simple Grid configuration.
122
+
123
+ ```bash
124
+ # Create Kendo UI for jQuery app with Grid Template
125
+ npx kendo jquery create jga MyjQueryGridApp
126
+ ```
127
+
128
+ 6. ***Standard Template*** - An ASP.NET MVC project that showcases some of the navigational components in the Kendo UI for jQuery suite, such as PanelBar, Menu, TabStrip, and TreeView.
129
+
130
+ ```bash
131
+ # Create Kendo UI for jQuery app with Standard Template
132
+ npx kendo jquery create jsa MyjQueryStandardApp
133
+ ```
134
+
135
+ ### Options
136
+
137
+ Theme options:
138
+
139
+ - `--theme=default`
140
+ - `--theme=bootstrap`
141
+ - `--theme=material`
142
+ - `--theme=fluent`
143
+
144
+
145
+ ### Build and Run
146
+
147
+ After the project is generated, navigate into the new directory, install packages, build and run:
148
+
149
+ ```bash
150
+ cd MyKendojQueryApp
151
+ npm install
152
+ npm start
153
+ ```
154
+
155
+ ### Kendo UI for jQuery Project Generator Synopsis
156
+
157
+ ```
158
+ kendo jquery create [template] [name]
159
+
160
+ Create a new jQuery app.
161
+
162
+ Commands:
163
+ kendo jquery create jqa [name] Create jQuery Admin app
164
+ kendo jquery create jba [name] Create jQuery Blank app
165
+ kendo jquery create jda [name] Create jQuery Dashboard app
166
+ kendo jquery create jdla [name] Create jQuery Dashboard Layout app
167
+ kendo jquery create jga [name] Create jQuery Grid app
168
+ kendo jquery create jsa [name] Create jQuery Standard app
169
+
170
+ Options:
171
+ --help Show help [boolean]
172
+ --version Show version number [boolean]
173
+ -v, --verbose Set verbosity level, e.g. -vvv sets verbosity to level 3. max
174
+ 5. [count] [default: 1]
175
+ -q, --quiet Silence output as much as possible. Sets verbosity to level 0.
176
+ [boolean] [default: false]
177
+ --theme Kendo theme to apply.
178
+ [string] [choices: "default", "bootstrap", "material", "fluent"] [default: "default"]
179
+ ```
180
+
88
181
  ---
89
182
 
90
- _Copyright © 2023 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved._
183
+ *Copyright © 2023 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.*
91
184
 
92
- _Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software_ _Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries._
185
+ *Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software* *Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries.*