# <library-name>

your library description here.
Describe briefly the purpose of your library -- i.e. what functionalities does it provide.
For longer description, refer to [Usage](#usage).

Remove demo badge if this is a library without GUI. Also, delete this lines.

[![Licence](https://img.shields.io/badge/AGPL--3.0_with_additional_terms-olivegreen?style=plastic&label=License&logo=open-source-initiative&logoColor=white&color=olivegreen)](https://github.com/gobstones/<library-name>/blob/main/LICENSE) [![Version](https://img.shields.io/github/package-json/v/gobstones/gobstones-scripts?style=plastic&label=Version&logo=git-lfs&logoColor=white&color=crimson)](https://www.npmjs.com/package/@gobstones/gobstones-scripts)

[![API Docs](https://img.shields.io/github/package-json/homepage/gobstones/gobstones-scripts?color=blue&label=API%20Docs&logo=gitbook&logoColor=white&style=plastic)](https://gobstones.github.io/gobstones-scripts)

[![Demo Page](https://img.shields.io/github/package-json/demopage/gobstones/<library-name>?color=magenta&label=Demo%20Page&logo=storybook&logoColor=white&style=plastic)](https://gobstones.github.io/<library-name>)

![GitHub Workflow Tests](https://img.shields.io/github/actions/workflow/status/gobstones/gobstones-scripts/on-commit-test.yml?style=plastic&label=Tests&logo=github-actions&logoColor=white) ![GitHub Workflow Build](https://img.shields.io/github/actions/workflow/status/gobstones/gobstones-scripts/on-commit-build.yml?style=plastic&label=Build&logo=github-actions&logoColor=white)

Add a longer description here if it's worth it.

## Install

Explain how to install this library using a package manager or more than one if
that is intended.

**npm:**

```
npm install --save @gobstones/<library-name>
```

You may add additional steps for installation and configuration of the library.

## Usage

Explain how to use your library, that is, how to import it into a project, the
basic API, and possibly some example use cases.

# CLI

If your library supports a CLI, explain how to use it, that is, which commands
and flags are available, what do they do, and so on.

If your library does not support CLI, you may remove this section entirely.

# Architecture

If worth it, you may explain how the library is organized, what modules are
used and how they should be modified, how to compile and so on.

## Contributing

See our [Contributions Guidelines](https://gobstones.github.io/gobstones-guidelines/) to contribute.