aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
blob: dc75be1c3b3bd3e8e9622408eaba112501bdca83 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# docs

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

A Gleam project

## Quick start

```sh
gleam run   # Run the project
gleam test  # Run the tests
gleam shell # Run an Erlang shell
```

## Installation

If available on Hex this package can be added to your Gleam project:

```sh
gleam add docs
```

and its documentation can be found at <https://hexdocs.pm/docs>.