@terrestris/ol-util/README.md

A set of helper classes for working with openLayers

# ol-util

[![npm version](https://img.shields.io/npm/v/@terrestris/ol-util.svg?style=flat-square)](https://www.npmjs.com/package/@terrestris/ol-util)
[![GitHub license](https://img.shields.io/github/license/terrestris/ol-util?style=flat-square)](https://github.com/terrestris/ol-util/blob/main/LICENSE)
[![Coverage Status](https://img.shields.io/coverallsCoverage/github/terrestris/ol-util?style=flat-square)](https://coveralls.io/github/terrestris/ol-util?branch=main)
![GitHub action build](https://img.shields.io/github/actions/workflow/status/terrestris/ol-util/on-push-main.yml?branch=main&style=flat-square)


A set of helper classes for working with OpenLayers

## Installation

```javascript static
npm i @terrestris/ol-util
```

Be aware that ol-util uses a ESM build, so make sure your downstream application's bundler includes it when transpiling.

## API Documentation

* Latest: [https://terrestris.github.io/ol-util/latest/index.html](https://terrestris.github.io/ol-util/latest/index.html)
* Docs for other versions are available via the following format:
  * v3.0.0 [https://terrestris.github.io/ol-util/3.0.0/index.html](https://terrestris.github.io/ol-util/3.0.0/index.html)

## Development

`npm run watch:buildto` can be used to inject an updated version of `ol-util` into another project. The script will also watch for further changes. Example usage for [react-geo](https://github.com/terrestris/react-geo):

```sh
npm run watch:buildto ../react-geo/node_modules/@terrestris/ol-util
```

## Release

A new version is released automatically for new commits to the main branch using [semantic release](https://github.com/semantic-release/semantic-release).

## Software Bill of Materials

You find the SBOM (Software Bill of Materials) in `sbom.json` at root level of the project.