Skip to content

Commit

Permalink
chore: update README.md (#440)
Browse files Browse the repository at this point in the history
  • Loading branch information
arturovt committed Apr 16, 2023
1 parent d2172d7 commit b4d2d98
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 19 deletions.
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
[![npm version](https://badge.fury.io/js/%40ngu%2Fcarousel.svg)](https://badge.fury.io/js/%40ngu%2Fcarousel)

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

Angular Universal carousel
Expand All @@ -20,6 +22,8 @@ Demo available [Here](https://ngu-carousel.netlify.app)

## Installation

`ngu-carousel` supports touch actions and requires `hammerjs` to be installed before the `ngu-carousel` is installed.

| Angular Version | ngu-carousel Version |
| --------------- | ----------------------------------- |
| Angular >= 15 | `npm i --save @ngu/carousel@latest` |
Expand All @@ -30,22 +34,6 @@ Demo available [Here](https://ngu-carousel.netlify.app)
| Angular = 9 | `npm i --save @ngu/carousel@2.1.0` |
| Angular < 9 | `npm i --save @ngu/carousel@1.5.5` |

### Optional Dependencies

#### hammer.js

Now ngu-carousel supports touch with the help of hammerjs.
You can install and import it in the `main.ts` file like this

```
npm install hammerjs --save
```

```typescript
// main.ts
import 'hammerjs';
```

## Usage

1. Include CarouselModule in your app module:
Expand Down
4 changes: 1 addition & 3 deletions libs/ngu/carousel/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
"@angular/common": "^15.0.0",
"@angular/core": "^15.0.0",
"@angular/animations": "^15.0.0",
"hammerjs": "^2.0.0",
"rxjs": "^7.0.0",
"zone.js": "^0.11.4"
},
"optionalDependencies": {
"hammerjs": "^2.0.0"
},
"dependencies": {
"tslib": "2.4.1"
},
Expand Down

0 comments on commit b4d2d98

Please sign in to comment.