create-enchilada 1.0.0 → 1.0.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
@@ -1,8 +1,59 @@
1
1
  <div align="center">
2
- A quick way to start your web applications.
2
+ <p>
3
+ <img src="https://raw.githubusercontent.com/Sharmaz/enchilada/refs/heads/main/media/enchilada-js-logo.svg" width="250" alt="enchiladajs logo"/>
3
4
  </p>
5
+
6
+ # Building apps with JavaScript — as if they were enchiladas!
4
7
  </div>
5
8
 
9
+ <p align="center">
10
+ <a href="https://www.npmjs.com/package/create-enchilada"><img src="https://img.shields.io/npm/v/create-enchilada?logo=npm&color=blue" alt="version"></a>
11
+ <a href="https://github.com/Sharmaz/enchilada/actions/workflows/unit_tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/Sharmaz/enchilada/unit_tests.yml?logo=jest&label=Tests" alt="tests"></a>
12
+ <a href="https://github.com/Sharmaz/enchilada/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Sharmaz/enchilada" alt="license"></a>
13
+ </p>
14
+
15
+ ## Usage
16
+ ### With npm
17
+ ```
18
+ npm create enchilada
19
+ ```
20
+
21
+ ### With pnpm
22
+ ```
23
+ pnpm create enchilada
24
+ ```
25
+
26
+ ### With yarn
27
+ ```
28
+ yarn create enchilada
29
+ ```
30
+
31
+ <img src="https://raw.githubusercontent.com/Sharmaz/enchilada/refs/heads/main/media/enchiladajs.gif" width="100%" alt="mk-app options"/>
32
+ </p>
33
+
34
+ ## CLI Options
35
+ ### Help:
36
+ ```
37
+ npm create enchilada --help
38
+ ```
39
+ or
40
+ ```
41
+ npm create enchilada -h
42
+ ```
43
+
44
+ ### Template:
45
+ ```
46
+ npm create enchilada -- --template [template-name] [app-name]
47
+ ```
48
+ or
49
+ ```
50
+ npm create enchilada -- -t [template-name] [app-name]
51
+ ```
52
+ E.g:
53
+ ```
54
+ npm create enchilada -- --template vanilla-js my-app
55
+ ```
56
+
6
57
  ### Template List
7
58
  | TEMPLATE | DESCRIPTION |
8
59
  | :------- | :---------- |