vue-simple-suggest - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "vue-simple-suggest",
   "description": "Feature-rich autocomplete component for Vue.js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "KazanExpress",
@@ -9,4 +9,5 @@ "license": "MIT",
   "scripts": {
-    "dev": "webpack-dev-server --mode development --config example/webpack.config.js --open --hot",
-    "build": "webpack --mode production --config example/webpack.config.js",
+    "dev": "npm run readme && webpack-dev-server --mode development --config example/webpack.config.js --open --hot",
+    "build": "npm run readme && webpack --mode production --config example/webpack.config.js",
+    "readme": "generate-md --layout github --input ./README.md --output ./example/src",
     "postversion": "npm run build",
@@ -53,2 +54,3 @@ "patch": "npm version patch && npm publish",
     "babel-preset-stage-3": "^6.24.1",
+    "copy-webpack-plugin": "^4.5.1",
     "core-js": "^2.5.3",
@@ -59,2 +61,3 @@ "css-loader": "^0.28.7",
     "html-webpack-plugin": "^3.0.6",
+    "markdown-styles": "^3.1.10",
     "vue-loader": "^14.2.1",
@@ -64,4 +67,5 @@ "vue-template-compiler": "^2.5.0",
     "webpack-cli": "^2.0.8",
-    "webpack-dev-server": "^3.1.0"
+    "webpack-dev-server": "^3.1.0",
+    "whatwg-fetch": "^2.0.3"
   }
 }

README.md

@@ -5,2 +5,8 @@ # vue-simple-suggest
 
+
+[![npm](https://img.shields.io/npm/v/vue-simple-suggest.svg?style=flat-square)](https://www.npmjs.com/package/vue-simple-suggest)
+[![live demo](https://img.shields.io/badge/demo-live-brightgreen.svg?style=flat-square)](https://kazanexpress.github.io/vue-simple-suggest/)
+[![](https://img.shields.io/badge/github-repo-lightgray.svg?style=flat-square)](https://github.com/KazanExpress/vue-simple-suggest)
+[![](https://img.shields.io/badge/very-awesome-orange.svg?style=flat-square)](https://github.com/vuejs/awesome-vue#autocomplete)
+
 ```bash
@@ -44,3 +50,3 @@ npm install --save vue-simple-suggest
 
-## What is it?
+## What is it
 
@@ -108,3 +114,3 @@ This is a simple yet feature-rich suggestion/autocomplete component for Vue.js.
 
-#### Props:
+#### Props
 | Name                         | Type     | Default  | Description                                                                                                                    |
@@ -115,3 +121,3 @@ |------------------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------------------|
 | `valueAttribute`               | String   | `'id'`     | The property in a suggestion object to use as a unique key. Supports dotted paths.                                      |
-| `getList`                      | Funciton | `() => []` | The array provider function, must accept a query as its only argument. Can return an array or a promise. Can be async. The component behaves as a simple input without this function. |
+| `getList`                      | Funciton or Array | `() => []` | The array provider function, must accept a query as its only argument. Can return an array or a promise. Can be async. The component behaves as a simple input without this function. |
 | `debounce`                     | Number   | `0`        | Determines the getList debounce (a time between the input event and a function execution).                                     |
@@ -123,3 +129,3 @@ | `destyled`                     | Boolean  | `false`    | Whether to cancel the default styling of input and suggestions list.                                                           |
 -----
-#### Events:
+#### Events
 | Name          | Arguments                   | Description                                                                                            |
@@ -140,3 +146,3 @@ |---------------|-----------------------------|--------------------------------------------------------------------------------------------------------|
 
-#### Ref Methods:
+#### Ref Methods
 > accessed via `$refs.*your ref name here*`
@@ -156,3 +162,3 @@
 
-#### Ref Data:
+#### Ref Data
 > accessed via `$refs.*your ref name here*`
@@ -177,3 +183,3 @@
 
-### Slots:
+### Slots
 
@@ -189,2 +195,3 @@ > all optional
 **Warning:** `v-model` on a custom input IS NOT the same as `v-model` on vue-simple-suggest!
+
 ```html
@@ -191,0 +198,0 @@ <!--  Default HTMLInputElement example:  -->

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

23020

increased by3.43%

Number of lines in readme file

269

increased by2.67%

Worsened metrics

Dev dependency count

17

increased by21.43%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes