Skip to main content

README.md

# cadre

[![Package Version](https://img.shields.io/hexpm/v/cadre)](https://hex.pm/packages/cadre)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/cadre/)

This is a [Lustre](https://lustre.hexdocs.pm) wrapper for [A-Frame](https://aframe.io).

## Installation

```sh
gleam add cadre
```

Then add A-Frame to `gleam.toml`:

```toml
[tools.lustre.html]
scripts = [{ src = "https://cdn.jsdelivr.net/npm/aframe@1.7.1/dist/aframe-master.min.js" }]
```

Further documentation can be found at <https://hexdocs.pm/cadre>.

## Credits

Special thanks to:

- [Emilia](https://bsky.app/profile/bewitching.dev) for the name suggestion.
- And the developers/contributors of [Tiramisu](https://github.com/renatillas/tiramisu), [Lustre](https://lustre.hexdocs.pm) and [A-Frame](https://aframe.io) for inspiring me to make this library.