Skip to content

Commit

Permalink
docs(readme): edit title, badge and instalation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
leomp12 committed Jun 29, 2020
1 parent 20e9bfa commit 2e3c160
Showing 1 changed file with 12 additions and 22 deletions.
34 changes: 12 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
# shopping-cart
# Shopping Cart

[![CodeFactor](https://www.codefactor.io/repository/github/ecomclub/shopping-cart/badge)](https://www.codefactor.io/repository/github/ecomclub/shopping-cart)
[![npm version](https://img.shields.io/npm/v/@ecomplus/shopping-cart.svg)](https://www.npmjs.org/@ecomplus/shopping-cart)
[![license mit](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Publish](https://github.com/ecomplus/shopping-cart/workflows/Publish/badge.svg)](https://github.com/ecomplus/shopping-cart/actions?workflow=Publish) [![CodeFactor](https://www.codefactor.io/repository/github/ecomplus/shopping-cart/badge)](https://www.codefactor.io/repository/github/ecomplus/shopping-cart) [![npm version](https://img.shields.io/npm/v/@ecomplus/shopping-cart.svg)](https://www.npmjs.org/@ecomplus/shopping-cart) [![license mit](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

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)
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)

[Changelog](https://github.com/ecomclub/shopping-cart/blob/master/CHANGELOG.md)
[CHANGELOG](https://github.com/ecomplus/shopping-cart/blob/master/CHANGELOG.md)

## Usage

The `@ecomplus/shopping-cart` package can be used to persist
and treat shopping cart data on E-Com Plus stores (and not only).
The `@ecomplus/shopping-cart` package can be used to persist and treat shopping cart data on E-Com Plus stores (and not only).

It's available for both Node.js and browser environments.

Expand Down Expand Up @@ -43,24 +38,20 @@ ecomCart.addItem({
ecomCart.increaseItemQnt('12300000000000000000000f', 3)
```

### Dependencies
### Installation

It requires and _may not_ include:
It _may_ require and doesn't include `core-js` (optional) and [`@ecomplus/utils`](https://developers.e-com.plus/utils/) (peer dependency).

- `core-js`;
- [`eventemitter3`](https://github.com/primus/eventemitter3);
- [`@ecomplus/utils`](https://github.com/ecomclub/ecomplus-utils);

#### Node.js
#### Webpack

```bash
npm i --save @ecomplus/utils @ecomplus/shopping-cart
npm i --save core-js @ecomplus/utils @ecomplus/shopping-cart
```

#### Webpack
#### Node.js

```bash
npm i --save core-js @ecomplus/utils @ecomplus/shopping-cart
npm i --save @ecomplus/utils @ecomplus/shopping-cart
```

#### CDN
Expand All @@ -69,5 +60,4 @@ npm i --save core-js @ecomplus/utils @ecomplus/shopping-cart
<script src="https://cdn.jsdelivr.net/npm/@ecomplus/shopping-cart/dist/ecom-cart.var.min.js"></script>
```

`EventEmitter3` and `ecomUtils` libraries **must be included separately**
and available on window scope.
When importing from CDN, `EventEmitter3` and `ecomUtils` libraries **must be included separately** and available on window scope.

0 comments on commit 2e3c160

Please sign in to comment.