[![Piral Logo](https://github.com/smapiot/piral/raw/main/docs/assets/logo.png)](https://piral.io)

# [Piral](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/piral.svg?style=flat)](https://www.npmjs.com/package/piral) [![tested with vitest](https://img.shields.io/badge/tested_with-vitest-99424f.svg)](https://vitest.dev/) [![Community Chat](https://img.shields.io/discord/1222632475449229352)](https://discord.gg/kKJ2FZmK8t)

This is the combined library that yields the most complete Piral instance. Layouts can build upon this layer. `piral` is fully opinionated about the provided backend structure and functional use, however, leaves rendering completely to the implementor (or some library).

## Documentation

For details on the use of Piral see the [documentation at the Piral website](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/main/docs).

## License

Piral is released using the MIT license. For more information see the [license file](./LICENSE).