# pontil/summary

[![Hex.pm][shield-hex]][hexpm] [![Hex Docs][shield-docs]][docs]
[![Apache 2.0][shield-licence]][licence] ![JavaScript Compatible][shield-js]
![Erlang Compatible][shield-erlang]

Pontil summary implements the functionality of [actions/core summary][summary],
which builds job summary output for GitHub Actions output, and is ported from
the GitHub Actions [toolkit][gha-toolkit].

`pontil_summary` works with all Gleam targets and runtimes.

## Usage

```sh
gleam add pontil_summary@1
```

```gleam
import pontil/summary

pub fn main() {
  summary.new()
  |> summary.h2("Test Results")
  |> summary.raw("<b>All tests passed.</b>")
  |> summary.append()
}
```

## Semantic Versioning

Pontil summary follows [Semantic Versioning 2.0][semver].

[docs]: https://hexdocs.pm/pontil_summary
[gha-toolkit]: https://github.com/actions/toolkit
[hexpm]: https://hex.pm/package/pontil_summary
[licence]: https://github.com/halostatue/pontil/blob/main/pontil_summary/LICENCE.md
[pontil]: https://hexdocs.pm/pontil
[semver]: https://semver.org/
[shield-docs]: https://img.shields.io/badge/hex-docs-lightgreen.svg?style=for-the-badge "Hex Docs"
[shield-erlang]: https://img.shields.io/badge/target-erlang-f3e155?style=for-the-badge "Erlang Compatible"
[shield-hex]: https://img.shields.io/hexpm/v/pontil_summary?style=for-the-badge "Hex Version"
[shield-js]: https://img.shields.io/badge/target-javascript-f3e155?style=for-the-badge "Javascript Compatible"
[shield-licence]: https://img.shields.io/hexpm/l/pontil_summary?style=for-the-badge&label=licence "Apache 2.0"
[summary]: https://github.com/actions/toolkit/blob/main/packages/core/src/summary.ts