From b4d2d98f8dc67c935cd8f40e474dd39702f43ff5 Mon Sep 17 00:00:00 2001 From: Artur Androsovych Date: Sun, 16 Apr 2023 19:39:50 +0300 Subject: [PATCH] chore: update README.md (#440) --- README.md | 20 ++++---------------- libs/ngu/carousel/package.json | 4 +--- 2 files changed, 5 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 37b962c5..abbe375a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ [![npm version](https://badge.fury.io/js/%40ngu%2Fcarousel.svg)](https://badge.fury.io/js/%40ngu%2Fcarousel) + [![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-) + Angular Universal carousel @@ -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` | @@ -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: diff --git a/libs/ngu/carousel/package.json b/libs/ngu/carousel/package.json index 7b3a446b..8d833385 100644 --- a/libs/ngu/carousel/package.json +++ b/libs/ngu/carousel/package.json @@ -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" },