fix: lock file maintenance (#21)

Co-authored-by: Renovate Bot <[email protected]>
Co-authored-by: dword <[email protected]>

Author: 3 people

.github/workflows/sync-metadata.yml

@@ -3,10 +3,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: dword-design/action-sync-node-meta@fork
+      - uses: jaid/action-sync-node-meta@v2.0.0
         with:
           approve: false
-          commitMessagePrefix: "fix:"
+          commitMessage: "fix: write GitHub metadata to package.json [{changes}]"
           githubToken: ${{ secrets.GITHUB_TOKEN }}
 name: sync-metadata
 on:

.renovaterc.json

@@ -13,17 +13,8 @@
   },
   "packageRules": [
     {
-      "packagePatterns": [
-        "*"
-      ],
-      "semanticCommitType": "chore"
-    },
-    {
-      "depTypeList": [
-        "dependencies",
-        "devDependencies",
-        "peerDependencies",
-        "optionalDependencies"
+      "matchPaths": [
+        "package.json"
       ],
       "semanticCommitType": "fix"
     }

README.md

@@ -53,6 +53,7 @@
 A Vue.js component that turns a Mermaid string into a diagram.
 <!-- /DESCRIPTION -->
 
+<!-- INSTALL/ -->
 ## Install Via a Package Manager
 ```bash
 # npm
@@ -62,16 +63,18 @@ $ npm install vue-mermaid-string
 $ yarn add vue-mermaid-string
 ```
 
-Add to Local Components:
+Add to local components:
 
 ```js
+<script>
 import VueMermaidString from 'vue-mermaid-string'
 
 export default {
   components: {
     VueMermaidString,
   },
 }
+</script>
 ```
 
 Or register as global component:
@@ -99,6 +102,54 @@ Vue.use(VueMermaidString)
 <script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
 <script src="https://unpkg.com/vue-mermaid-string"></script>
 ```
+<!-- /INSTALL -->
+
+<!--## Install Via a Package Manager
+```bash
+# npm
+$ npm install vue-mermaid-string
+
+# Yarn
+$ yarn add vue-mermaid-string
+```
+
+Add to Local Components:
+
+```js
+import VueMermaidString from 'vue-mermaid-string'
+
+export default {
+  components: {
+    VueMermaidString,
+  },
+}
+```
+
+Or register as global component:
+
+```js
+import Vue from 'vue'
+import VueMermaidString from 'vue-mermaid-string'
+
+Vue.component('VueMermaidString', VueMermaidString)
+```
+
+Or register as plugin:
+
+```js
+import Vue from 'vue'
+import VueMermaidString from 'vue-mermaid-string'
+
+Vue.use(VueMermaidString)
+```
+
+## Install Via CDN
+
+```html
+<script src="https://unpkg.com/vue"></script>
+<script src="https://unpkg.com/mermaid/dist/mermaid.min.js"></script>
+<script src="https://unpkg.com/vue-mermaid-string"></script>
+```-->
 
 ## Usage
 

package.json

@@ -42,6 +42,9 @@
   },
   "baseConfig": {
     "name": "@dword-design/component",
-    "testInContainer": true
+    "testInContainer": true,
+    "cdnExtraScripts": [
+      "<script src=\"https://unpkg.com/mermaid/dist/mermaid.min.js\"></script>"
+    ]
   }
 }