README.md

# qol_gleam

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

This is a "quality of life" library for Gleam, an unofficial helper package for
the standard library (and other official libraries).

You can also use this library as a collection of functions, a buffet of code
snippets to conveniently copy and use. To vendor a function into your codebase,
simply go to the function on the document, click the `</>` button to view its
source, then copy.

> [!NOTE]
> QOL-Gleam is meant to be use for end users. If you are developing a
> library, do not add QOL-Gleam to your library's dependencies, it'll
> unnecessarily make your library bloat, just vendor functions that you used
> into your codebase instead.

## Installation

```sh
gleam add qol_gleam
```

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

## Credits

Special thanks to:

- [justin](https://github.com/lpil/justin) by [Louis Pilfold](https://lpil.uk)