create-rspeedy-canary/README.md

Deprecated: use @lynx-js/create-lynx instead

<p align="center">
  <a href="https://lynxjs.org/rspeedy" target="blank"><img src="https://lf-lynx.tiktok-cdns.com/obj/lynx-artifacts-oss-sg/lynx-website/assets/rspeedy-banner.png" alt="Rspeedy Logo" /></a>
</p>

# create-rspeedy

> [!IMPORTANT]
> This package is superseded by [`@lynx-js/create-lynx`](https://www.npmjs.com/package/@lynx-js/create-lynx), which it now delegates to.
> It stays pinned to Rspeedy; `@lynx-js/create-lynx` scaffolds for both Rsbuild and Rspeedy.
>
> ```bash
> npm create @lynx-js/lynx@latest
> ```

Create a new Rspeedy x ReactLynx project.

Using `npm create`:

```bash
npm create rspeedy@latest
```

Using CLI flags:

```bash
npx create-rspeedy --dir my-project

# Using abbreviations
npx create-rspeedy -d my-project
```

## Documentation

https://lynxjs.org/rspeedy

## Contributing

Please read the [Contributing Guide](https://github.com/lynx-family/lynx-stack/blob/main/CONTRIBUTING.md).

## License

Rspeedy is [Apache-2.0 licensed](https://github.com/lynx-family/lynx-stack/blob/main/LICENSE).