dependent-selects - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

dist/dependent-selects.common.js

 /*!
- * dependent-selects.js v0.1.0
+ * dependent-selects.js v0.1.1
  * https://github.com/lmk123/dependent-selects
@@ -4,0 +4,0 @@ * Released under the MIT License.

dist/dependent-selects.esm.js

 /*!
- * dependent-selects.js v0.1.0
+ * dependent-selects.js v0.1.1
  * https://github.com/lmk123/dependent-selects
@@ -4,0 +4,0 @@ * Released under the MIT License.

dist/dependent-selects.js

 /*!
- * dependent-selects.js v0.1.0
+ * dependent-selects.js v0.1.1
  * https://github.com/lmk123/dependent-selects
@@ -4,0 +4,0 @@ * Released under the MIT License.

dist/dependent-selects.min.js

 /*!
- * dependent-selects.js v0.1.0
+ * dependent-selects.js v0.1.1
  * https://github.com/lmk123/dependent-selects
@@ -4,0 +4,0 @@ * Released under the MIT License.

package.json

 {
   "name": "dependent-selects",
-  "version": "0.1.0",
-  "description": "An easy way to create asynchronous multi-level select boxes.",
+  "version": "0.1.1",
+  "description": "An easy way to create asynchronous dependent selects boxes.",
   "main": "dist/dependent-selects.common.js",
@@ -45,2 +45,7 @@ "module": "dist/dependent-selects.esm.js",
   "license": "MIT",
+  "keywords": [
+    "dependent",
+    "selects",
+    "asynchronous"
+  ],
   "bugs": {
@@ -47,0 +52,0 @@ "url": "https://github.com/lmk123/dependent-selects/issues"

README.md

@@ -1,1 +0,48 @@
-todo
+# Dependent Selects
+
+Help you to create dependent selects boxes such as regions (for example, country -> district -> street).
+
+## Features
+
+ - Asynchronous, based on [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+ - 1.2KB only (min+gzip)
+ - No UI, so you can (and have to) customize UI by yourself
+
+## Usage & Examples
+
+There is an fully example: https://jsfiddle.net/lmk123/8d2x8dLy/
+
+Another example with [Vue.js](https://vuejs.org/): https://jsfiddle.net/lmk123/40k949en/
+
+## Install
+
+```
+npm install dependent-selects --save
+```
+
+In Webpack:
+
+```js
+import DependentSelects from 'dependent-selects'
+
+const multi = new DependentSelects(queryFunction)
+// ...
+```
+
+In browser:
+
+```html
+<script src="node_modules/dependent-selects/dist/dependent-selects.js"></script>
+<script>
+  var multi = new DependentSelects(queryFunction)
+  // ...
+</script>
+```
+
+## API
+
+Please see the above examples.
+
+## 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

Lines of code

644

increased by26.03%

Number of lines in readme file

49

increased by2350%

Worsened metrics

Total package byte prevSize

27551

decreased by-65.95%

Number of package files

7

decreased by-66.67%

No dependency changes