beautify-scrollbar - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
-    "name": "beautify-scrollbar",
-    "version": "0.0.1",
-    "description": "Beautify browser's scrollbars",
-    "author": "dwqs",
-    "license": "MIT",
-    "main": "dist/index.js",
-    "private": false,
-    "repository": {
-      "type": "git",
-      "url": "https://github.com/dwqs/beautify-scrollbar.git"
-    },
-    "bugs": {
-      "url": "https://github.com/dwqs/beautify-scrollbar/issues"
-    },
-    "homepage": "https://github.com/dwqs/beautify-scrollbar",
-    "keywords": [
-      "js",
-      "javascript",
-      "beautify",
-      "scrollbar",
-      "beautify-scrollbar"
-    ],
-    "files": [
-      "dist",
-      "README.md",
-      "package.json"
-    ],
-    "scripts": {
-      "prepush": "npm run ilint -q",
-      
-      "ilint": "npx eslint src/**/*.js",
-      "fix": "npx eslint --fix src/**/*.js",
-      "test": "npm run ilint",
-      "commitmsg": "npx commitlint -e",
-      "dev": "npx cross-env NODE_ENV=development node ./build/dev-server.js",
-      "build": "rm -rf dist && npx cross-env NODE_ENV=production npx webpack --config ./webpack.build.config.js --hide-modules",
-      "build:exam": "npx cross-env NODE_ENV=production npx webpack --config ./build/webpack.prod.config.js --hide-modules && mv ./examples/dist/index.html ./"
-    },
-    "dependencies": {},
-    "devDependencies": {
-      "@commitlint/cli": "^6.1.2",
-      "@commitlint/config-angular": "^6.1.2",
-      "autoprefixer": "^8.0.0",
-      "babel-core": "^6.26.0",
-      "babel-eslint": "^8.2.2",
-      "babel-loader": "^7.1.3",
-      "babel-plugin-transform-runtime": "^6.23.0",
-      "babel-preset-env": "^1.6.1",
-      "babel-preset-stage-2": "^6.24.1",
-      "clean-webpack-plugin": "^0.1.18",
-      "compression-webpack-plugin": "^1.1.9",
-      "cross-env": "^5.0.5",
-      "css-loader": "^0.28.10",
-      "cssnano": "^3.10.0",
-      "cz-conventional-changelog": "^2.1.0",
-      "eslint": "^4.18.1",
-      "extract-text-webpack-plugin": "^4.0.0-alpha.0",
-      "html-webpack-plugin": "github:webpack-contrib/html-webpack-plugin",
-      "husky": "^0.14.3",
-      "less": "^3.0.1",
-      "less-loader": "^4.0.6",
-      "open-browser-webpack-plugin": "^0.0.5",
-      "optimize-css-assets-webpack-plugin": "^3.2.0",
-      "postcss-loader": "^2.1.1",
-      "progress-bar-webpack-plugin": "^1.11.0",
-      "webpack": "^4.0.0",
-      "webpack-cli": "^2.0.9",
-      "webpack-dev-server": "^3.0.0",
-      "webpack-md5-hash": "^0.0.6",
-      "uglifyjs-webpack-plugin": "^1.2.2"
-    },
-    "engines": {
-      "node": ">= 6.0.0",
-      "npm": ">= 5.2.0"
-    },
-    "config": {
-      "commitizen": {
-        "path": "./node_modules/cz-conventional-changelog"
-      }
+  "name": "beautify-scrollbar",
+  "version": "0.0.2",
+  "description": "Beautify browser's scrollbars",
+  "author": "dwqs",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dwqs/beautify-scrollbar.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dwqs/beautify-scrollbar/issues"
+  },
+  "homepage": "https://github.com/dwqs/beautify-scrollbar",
+  "keywords": [
+    "js",
+    "javascript",
+    "beautify",
+    "scrollbar",
+    "beautify-scrollbar"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ],
+  "scripts": {
+    "prepush": "npm run ilint -q",
+    "prepublishOnly": "npm run build",
+    "ilint": "npx eslint src/**/*.js",
+    "fix": "npx eslint --fix src/**/*.js",
+    "test": "npm run build",
+    "commitmsg": "npx commitlint -e",
+    "dev": "npx cross-env NODE_ENV=development node ./build/dev-server.js",
+    "build": "rm -rf dist && npx cross-env NODE_ENV=production npx webpack --config ./webpack.build.config.js --hide-modules",
+    "build:exam": "npx cross-env NODE_ENV=production npx webpack --config ./build/webpack.prod.config.js --hide-modules && mv ./examples/dist/index.html ./"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@commitlint/cli": "^6.1.2",
+    "@commitlint/config-angular": "^6.1.2",
+    "autoprefixer": "^8.0.0",
+    "babel-core": "^6.26.0",
+    "babel-loader": "^7.1.3",
+    "babel-plugin-transform-runtime": "^6.23.0",
+    "babel-preset-env": "^1.6.1",
+    "babel-preset-stage-2": "^6.24.1",
+    "clean-webpack-plugin": "^0.1.18",
+    "compression-webpack-plugin": "^1.1.9",
+    "cross-env": "^5.0.5",
+    "css-loader": "^0.28.10",
+    "cssnano": "^3.10.0",
+    "cz-conventional-changelog": "^2.1.0",
+    "eslint": "^4.18.1",
+    "eslint-config-standard": "^11.0.0",
+    "eslint-plugin-import": "^2.9.0",
+    "eslint-plugin-node": "^6.0.1",
+    "eslint-plugin-promise": "^3.6.0",
+    "eslint-plugin-standard": "^3.0.1",
+    "extract-text-webpack-plugin": "^4.0.0-alpha.0",
+    "html-webpack-plugin": "github:webpack-contrib/html-webpack-plugin",
+    "husky": "^0.14.3",
+    "less": "^3.0.1",
+    "less-loader": "^4.0.6",
+    "open-browser-webpack-plugin": "^0.0.5",
+    "optimize-css-assets-webpack-plugin": "^3.2.0",
+    "postcss-loader": "^2.1.1",
+    "progress-bar-webpack-plugin": "^1.11.0",
+    "uglifyjs-webpack-plugin": "^1.2.2",
+    "vue": "^2.5.13",
+    "vue-loader": "^14.1.1",
+    "vue-style-loader": "^4.0.2",
+    "vue-template-compiler": "^2.5.13",
+    "webpack": "^4.0.0",
+    "webpack-cli": "^2.0.9",
+    "webpack-dev-server": "^3.0.0",
+    "webpack-md5-hash": "^0.0.6"
+  },
+  "engines": {
+    "node": ">= 6.0.0",
+    "npm": ">= 5.2.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
     }
-  }
+  }
+}

README.md

@@ -0,2 +1,44 @@
+[![build pass](https://api.travis-ci.org/dwqs/beautify-scrollbar.svg?branch=master)](https://travis-ci.org/dwqs/beautify-scrollbar) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com) ![npm-version](https://img.shields.io/npm/v/beautify-scrollbar.svg) ![license](https://img.shields.io/npm/l/beautify-scrollbar.svg)
 # beautify-scrollbar
-Beautify browser's scrollbars
+Beautify browser's scrollbars.
+
+## Installation
+
+npm:
+
+```
+npm i --save beautify-scrollbar
+```
+or yarn
+
+```
+yarn add  beautify-scrollbar
+```
+
+## Get Started
+
+```
+import BeautifyScrollbar from 'beautify-scrollbar';
+
+const container = document.querySelector('#container')
+const bs = new BeautifyScrollbar(container);
+
+// or
+const bs = new BeautifyScrollbar('#container');
+```
+
+Visit the [examples](https://dwqs.github.io/beautify-scrollbar).
+
+## Development
+```
+git clone [e-mail]:dwqs/beautify-scrollbar.git
+
+cd beautify-scrollbar
+
+npm i 
+
+npm run dev
+```
+
+## LICENSE
+MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15390

increased by309.2%

Number of package files

4

increased by33.33%

Number of lines in readme file

44

increased by1366.67%

Worsened metrics

Dev dependency count

38

increased by26.67%

No dependency changes