create-knyt/README.md

A scaffolding tool to generate new Knyt projects from boilerplates.

<div align="center">

[![Knyt](./docs/banner.svg)](https://knyt.dev/guide/quick-start/)

🐣 A CLI tool for scaffolding Knyt projects.

<small>

This package is part of [Knyt](https://knyt.dev/), a toolkit designed to simplify modern web development.

</small>

[![npm](https://img.shields.io/npm/v/create-knyt?style=flat-square&labelColor=444)](https://www.npmjs.com/package/create-knyt)
[![GitHub](https://img.shields.io/badge/Source_Code-black?style=flat-square&label=GitHub&labelColor=444)](https://github.com/sables-app/knyt/tree/main/packages/create)
[![License](https://img.shields.io/badge/License-BSD_3_Clause-blue?style=flat-square&labelColor=444)](https://github.com/sables-app/knyt/blob/main/LICENSE)
<br />
![Built with TypeScript](https://img.shields.io/badge/Built%20with-TypeScript-3178c6.svg?style=flat-square&logo=typescript&labelColor=444)
![Runs on Bun](https://img.shields.io/badge/Runs%20on-Bun-b49090.svg?style=flat-square&logo=bun&labelColor=444)
![Runs on Node](https://img.shields.io/badge/Runs%20on-Node-5fa04e.svg?style=flat-square&logo=nodedotjs&labelColor=444)

</div>

## Documentation

View the [quick start guide](https://knyt.dev/guide/quick-start) to get started with creating a new Knyt project.

## Running the CLI

To run the CLI, you can use one of the following commands:

> **Prerequisite:** Either Node.js or Bun must be installed in your environment.

_With npm:_

```sh
npm create knyt@latest
```

_With Bun:_

```sh
bun create knyt@latest
```

_With pnpm:_

```sh
pnpm create knyt@latest
```

## Updates

See the [CHANGELOG](./CHANGELOG.md) for a list of changes.

## License

This package is licensed under the [BSD 3-Clause License](./LICENSE).

## Open-Source Initiative

This project is supported by [Sables Applications LLC](https://sables.app) as part of its open-source initiatives.