create-maizzle - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
-    "name": "create-maizzle",
-    "version": "0.0.1",
-    "description": "Quickly start a new Maizzle project.",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/maizzle/framework.git"
-    },
-    "bugs": "https://github.com/maizzle/framework/issues",
-    "homepage": "https://maizzle.com",
-    "author": "Cosmin Popovici (https://github.com/cossssmin)"
+  "name": "create-maizzle",
+  "version": "0.1.0",
+  "description": "Quickly start a new Maizzle project.",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "create-maizzle": "bin/create-maizzle.mjs"
+  },
+  "files": [
+    "bin"
+  ],
+  "scripts": {
+    "release": "np",
+    "test": "echo \"Error: no test specified\" && exit 0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/maizzle/create-maizzle.git"
+  },
+  "bugs": "https://github.com/maizzle/create-maizzle/issues",
+  "homepage": "https://maizzle.com",
+  "author": "Cosmin Popovici (https://github.com/cossssmin)",
+  "keywords": [
+    "maizzle",
+    "create-maizzle",
+    "create-email",
+    "tailwindcss",
+    "responsive-email",
+    "email-framework",
+    "email-template",
+    "email-marketing",
+    "email-campaigns",
+    "email-newsletter",
+    "email-boilerplate",
+    "html-emails",
+    "email-cli"
+  ],
+  "dependencies": {
+    "@clack/prompts": "^0.7.0",
+    "degit": "^2.8.4",
+    "nypm": "^0.3.6",
+    "picocolors": "^1.0.0"
+  },
+  "devDependencies": {
+    "np": "^9.2.0"
+  }
 }

README.md

@@ -5,8 +5,8 @@ <div align="center">
       <picture>
-        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/maizzle/framework/HEAD/.github/media/logo-dark.svg">
-        <img alt="Maizzle" src="https://raw.githubusercontent.com/maizzle/framework/HEAD/.github/media/logo-light.svg" width="300" height="225" style="max-width: 100%;">
+        <source media="(prefers-color-scheme: dark)" srcset="https://github.com/maizzle/create-maizzle/raw/master/.github/cli-mark-dark.svg">
+        <img alt="Maizzle" src="https://github.com/maizzle/create-maizzle/raw/master/.github/cli-mark-light.svg" width="300" height="225" style="max-width: 100%;">
       </picture>
     </a>
   </p>
-  <p>Quickly build HTML emails with utility-first CSS</p>
+  <p>Quickly scaffold a Maizzle project</p>
   <div>
@@ -26,2 +26,24 @@
 
+## Usage
+
+```bash
+npx create-maizzle
+```
+
+Then, follow the prompts to create a new Maizzle project.
+
+## Installation
+
+You may also install the tool locally:
+
+```bash
+npm install -g create-maizzle
+```
+
+This will make the command available globally on your machine:
+
+```bash
+create-maizzle
+```
+
 ## Documentation
@@ -35,9 +57,9 @@
 
-[npm]: https://www.npmjs.com/package/@maizzle/framework
-[npm-stats]: https://npm-stat.com/charts.html?package=%40maizzle%2Fframework&from=2019-03-27
-[npm-version-shield]: https://img.shields.io/npm/v/@maizzle/framework.svg
-[npm-stats-shield]: https://img.shields.io/npm/dt/@maizzle/framework.svg?color=4f46e5
-[github-ci]: https://github.com/maizzle/framework/actions
-[github-ci-shield]: https://github.com/maizzle/framework/actions/workflows/nodejs.yml/badge.svg
+[npm]: https://www.npmjs.com/package/create-maizzle
+[npm-stats]: http://npm-stats.org/#/create-maizzle
+[npm-version-shield]: https://img.shields.io/npm/v/create-maizzle.svg
+[npm-stats-shield]: https://img.shields.io/npm/dt/create-maizzle.svg?color=4f46e5
+[github-ci]: https://github.com/maizzle/create-maizzle/actions
+[github-ci-shield]: https://github.com/maizzle/create-maizzle/actions/workflows/nodejs.yml/badge.svg
 [license]: ./LICENSE
-[license-shield]: https://img.shields.io/npm/l/@maizzle/framework.svg?color=0e9f6e
+[license-shield]: https://img.shields.io/npm/l/create-maizzle.svg?color=0e9f6e

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2923

increased by45.93%

Number of package files

3

increased by50%

Lines of code

3

increased byInfinity%

Number of lines in readme file

63

increased by53.66%

Is type module

Yes

Worsened metrics

Dependency count

4

increased byInfinity%

Dev dependency count

1

increased byInfinity%

Number of low quality alerts

2

increased by100%

Dependency changes

• + Added@clack/prompts@^0.7.0

• + Addeddegit@^2.8.4

• + Addednypm@^0.3.6

• + Addedpicocolors@^1.0.0

• + Added@clack/core@0.3.5(transitive)

• + Added@clack/prompts@0.7.0(transitive)

• + Addedacorn@8.14.0(transitive)

• + Addedcitty@0.1.6(transitive)

• + Addedconfbox@0.1.8(transitive)

• + Addedconsola@3.2.3(transitive)

• + Addedcross-spawn@7.0.6(transitive)

• + Addeddegit@2.8.4(transitive)

• + Addedexeca@8.0.1(transitive)

• + Addedget-stream@8.0.1(transitive)

• + Addedhuman-signals@5.0.0(transitive)

• + Addedis-stream@3.0.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedmerge-stream@2.0.0(transitive)

• + Addedmimic-fn@4.0.0(transitive)

• + Addedmlly@1.7.3(transitive)

• + Addednpm-run-path@5.3.0(transitive)

• + Addednypm@0.3.12(transitive)

• + Addedonetime@6.0.0(transitive)

• + Addedpath-key@3.1.14.0.0(transitive)

• + Addedpathe@1.1.2(transitive)

• + Addedpicocolors@1.1.1(transitive)

• + Addedpkg-types@1.2.1(transitive)

• + Addedshebang-command@2.0.0(transitive)

• + Addedshebang-regex@3.0.0(transitive)

• + Addedsignal-exit@4.1.0(transitive)

• + Addedsisteransi@1.0.5(transitive)

• + Addedstrip-final-newline@3.0.0(transitive)

• + Addedufo@1.5.4(transitive)

• + Addedwhich@2.0.2(transitive)