# Order Items (NPM Package)

[![Build Status](https://travis-ci.org/vtex/order-items.svg?branch=master)](https://travis-ci.org/vtex/order-items)
[![License](https://badgen.net/github/license/vtex/order-items)](./LICENSE)
[![Library minified size](https://badgen.net/bundlephobia/min/@vtex/order-items)](https://bundlephobia.com/result?p=@vtex/order-items)
[![Library minified + gzipped size](https://badgen.net/bundlephobia/minzip/@vtex/order-items)](https://bundlephobia.com/result?p=@vtex/order-items)

This package is an abstraction to decouple the Order Items logic from VTEX IO. Refer to the [original repository](https://github.com/vtex-apps/order-items/) for more information.

## Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

```sh
npm install @vtex/order-items --save

# For Yarn, use the command below.
yarn add @vtex/order-items
```

### Installation from CDN

This module has an UMD bundle available through JSDelivr and Unpkg CDNs.

```html
<!-- For UNPKG use the code below. -->
<script src="https://unpkg.com/@vtex/order-items"></script>

<!-- For JSDelivr use the code below. -->
<script src="https://cdn.jsdelivr.net/npm/@vtex/order-items"></script>

<script>
  // UMD module is exposed through the "orderItems" global variable.
  console.log(orderItems)
</script>
```

## Releasing

Use [releasy](https://www.npmjs.com/package/releasy) to create new tag to be released. After the tag is created, run `npm publish`

## License

Released under [MIT License](./LICENSE).
