Skip to content

Commit b4d2d98

Browse files
authored
chore: update README.md (#440)
1 parent d2172d7 commit b4d2d98

File tree

2 files changed

+5
-19
lines changed

2 files changed

+5
-19
lines changed

README.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
[![npm version](https://badge.fury.io/js/%40ngu%2Fcarousel.svg)](https://badge.fury.io/js/%40ngu%2Fcarousel)
66

77
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
8+
89
[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)
10+
911
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1012

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

2123
## Installation
2224

25+
`ngu-carousel` supports touch actions and requires `hammerjs` to be installed before the `ngu-carousel` is installed.
26+
2327
| Angular Version | ngu-carousel Version |
2428
| --------------- | ----------------------------------- |
2529
| Angular >= 15 | `npm i --save @ngu/carousel@latest` |
@@ -30,22 +34,6 @@ Demo available [Here](https://ngu-carousel.netlify.app)
3034
| Angular = 9 | `npm i --save @ngu/[email protected]` |
3135
| Angular < 9 | `npm i --save @ngu/[email protected]` |
3236

33-
### Optional Dependencies
34-
35-
#### hammer.js
36-
37-
Now ngu-carousel supports touch with the help of hammerjs.
38-
You can install and import it in the `main.ts` file like this
39-
40-
```
41-
npm install hammerjs --save
42-
```
43-
44-
```typescript
45-
// main.ts
46-
import 'hammerjs';
47-
```
48-
4937
## Usage
5038

5139
1. Include CarouselModule in your app module:

libs/ngu/carousel/package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@
55
"@angular/common": "^15.0.0",
66
"@angular/core": "^15.0.0",
77
"@angular/animations": "^15.0.0",
8+
"hammerjs": "^2.0.0",
89
"rxjs": "^7.0.0",
910
"zone.js": "^0.11.4"
1011
},
11-
"optionalDependencies": {
12-
"hammerjs": "^2.0.0"
13-
},
1412
"dependencies": {
1513
"tslib": "2.4.1"
1614
},

0 commit comments

Comments
 (0)