Skip to content

Commit

Permalink
docs: getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
leomp12 authored Apr 29, 2019
1 parent 395137d commit 848c6cd
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,32 @@ Simple vanilla JS library to handle shopping cart with
common methods following
[E-Com Plus cart object model](https://developers.e-com.plus/docs/api/#/store/carts/carts)

## Getting started

**This library is available for browser only**

Include minified bundle via CDN:

```html
<script src="https://cdn.jsdelivr.net/npm/@ecomplus/shopping-cart@0/dist/shopping-cart.min.js"></script>
```

### With bundlers

If using `webpack` or `browserify` (or relateds),
you can also install the
[npm package](https://www.npmjs.com/package/@ecomplus/shopping-cart):

```bash
npm install --save @ecomplus/shopping-cart
```

And import the bundle file:

```js
import '@ecomplus/shopping-cart'
```

## Documentation

[`EcomCart` object and methods](https://developers.e-com.plus/shopping-cart/EcomCart.html)

0 comments on commit 848c6cd

Please sign in to comment.