create-maizzle/README.md

Quickly start a new Maizzle project.

<div align="center">
  <p>
    <a href="https://maizzle.com" target="_blank">
      <picture>
        <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 scaffold a Maizzle project</p>
  <div>

  [![Version][npm-version-shield]][npm]
  [![Build][github-ci-shield]][github-ci]
  [![Downloads][npm-stats-shield]][npm-stats]
  [![License][license-shield]][license]

  </div>
</div>

## About

CLI tool to help you quickly start a new Maizzle project.

## 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

Maizzle documentation is available at https://maizzle.com

## License

The Maizzle framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

[npm]: https://www.npmjs.com/package/create-maizzle
[npm-stats]: https://npm-stat.com/charts.html?package=create-maizzle&from=2024-02-15
[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/create-maizzle.svg?color=0e9f6e