@ringring/gsm/README.md

A utility library for short messages and mobile communication

<p align="center">
<a href="https://www.ringring.be" target="blank">
    <img src="https://www.ringring.be/wp-content/uploads/2019/09/logo.png" width="400" alt="Ring Ring Logo" />
  </a>
</p>

# Ring Ring GSM

A utility library for short messages and mobile communication

```
npm install @ringring/gsm
```

[Documentation](/docs/modules.md)

## Setup and Development

> **This library requires [PNPM](https://pnpm.io/installation) for package management**

To get started simply install dependencies using `pnpm run install` while inside the root directory.

The documentation in `docs/` can be updated using `pnpm run docs` after install.

### Test

```bash
# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov
```

### Misc.

```bash
# linting (eslint)
$ pnpm run lint

# format (prettier)
$ pnpm run format

# format + lint
$ pnpm run lf
```