Skip to main content

README.md

# fishgirl

Mermaid charts in a Lustre component.

Currently mostly for my own use.

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

```sh
gleam add fishgirl@1
```

See the [example](./examples/example_1/src/example_1.gleam) to see how it is used.

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

## Development

```sh
gleam run   # Run the project
gleam test  # Run the tests
```