@ou-imdt/utils/README.md

Utility library for interactive media development

# Utils 

[![npm version](https://badge.fury.io/js/@ou-imdt%2Futils.svg)](https://badge.fury.io/js/@ou-imdt%2Futils)


## Introduction

This library is a collection of utility functions designed to simplify various tasks in JavaScript development. The library focuses on utilities to be used in interactive media development for our VLE.

## Features

There are a wide range of utility functions for array manipulation, string handling, mathematical operations, and more. You can import only the utilities you need to keep your bundle size small. The library works seamlessly with any JavaScript framework or environment.

## Installation

Install `@ou-imdt/utils` via npm:

```bash
npm install @ou-imdt/utils
```

## Usage

> It is recommended to use Create tool, all vleUtils are included in the boilerplate. Check [Create README]([CREATE](https://bitbucket.org/lts-imd/create/src/main/readme.md)) for examples.


### Documentation

 All utils library documentation will be provided in a documentation site, in the meantime you can have a look any .js file in the library and find JSDoc annotations in the source code.


## Changelog

❯ [Read the changelog here](./changelog.md)

## Issue reporting

- Use the issue tracker.
- Provide a clear and descriptive title.
- Describe the steps to reproduce the issue (for bugs).
- Explain the expected and actual behavior (for bugs).
- Describe why the feature is needed (for feature requests).

## Licence

This project is licensed under the MIT License - see the [LICENSE](./LICENCE) for details.

## Contributing

See [contributing](./contributing.md) for more details.

## Contact

Alex, Charlotte, Edwin, Mustafa