diff --git a/README.md b/README.md index d316396..6dade33 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,37 @@ Include the angular-perfect-scrollbar files in your index.html: ``` +--- + +Install via NPM: + +```shell +$ npm install angular-perfect-scrollbar perfect-scrollbar --save +``` + +Import angular-perfect-scrollbar in your JavaScript: + +```js +import 'angular-perfect-scrollbar'; +``` + +Include perfect-scrollbar CSS, for instance with Webpack import it from within a JS or SCSS file: + +```js +import 'perfect-scrollbar/css/perfect-scrollbar.css'; +``` + +When using Webpack, the `angular` and `PerfectScrollbar` globals must be provided with the ProvidePlugin: + +```js +plugins: [ + new webpack.ProvidePlugin({ + 'angular': 'angular', + 'PerfectScrollbar': ['perfect-scrollbar', 'default'] + }) +] +``` + Usage ----- diff --git a/package.json b/package.json index 012ccce..3778e15 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,15 @@ { "name": "angular-perfect-scrollbar", - "version": "0.2.0", + "version": "0.2.1", "private": false, "main": "src/angular-perfect-scrollbar.js", "scripts": { "test": "grunt" }, "dependencies": {}, + "peerDependencies": { + "perfect-scrollbar": "^1.3.0" + }, "devDependencies": { "grunt": "^0.4.2", "grunt-contrib-jshint": "^0.8.0",