(docs) migrate docs

Author: FeBe95

docs/Installation.md

@@ -1,28 +1,24 @@
 # Installation
 
 ```bash
-npm install vue-js-modal --save
-```
-
-```bash
-yarn add vue-js-modal
+npm install @febe95/vue-js-modal --save
 ```
 
 ## Client
 
 Import plugin in your main file:
 
 ```js
-import VModal from 'vue-js-modal'
+import VModal from '@febe95/vue-js-modal'
 
 OR
 
-import VModal from 'vue-js-modal/dist/index.nocss.js'
-import 'vue-js-modal/dist/styles.css'
+import VModal from '@febe95/vue-js-modal/dist/index.nocss.js'
+import '@febe95/vue-js-modal/dist/styles.css'
 ```
 
 ```js
-Vue.use(VModal)
+app.use(VModal)
 ```
 
 ## SSR
@@ -44,16 +40,14 @@ export default {
 
 ```js
 // plugins/vue-js-modal.js
-import Vue from 'vue'
-import VModal from 'vue-js-modal/dist/ssr.nocss'
+import { defineNuxtPlugin } from 'nuxt/app'
+import VModal from '../../../dist/ssr.nocss'
 
-import 'vue-js-modal/dist/styles.css'
+import '../../../dist/styles.css'
 
-Vue.use(VModal, { ... })
-
-export default function(_, inject) {
-  inject('modal', Vue.prototype.$modal)
-}
+export default defineNuxtPlugin((nuxtApp) => {
+  nuxtApp.vueApp.use(VModal)
+})
 ```
 
 ::: tip Extracted CSS

docs/Intro.md

@@ -105,9 +105,9 @@ this.$modal.show({
 It is possible to set default property values for dynamic modals:
 
 ```js{4-8}
-import VModal from 'vue-js-modal'
+import VModal from '@febe95/vue-js-modal'
 
-Vue.use(VModal, {
+app.use(VModal, {
   dynamicDefaults: {
     draggable: true,
     resizable: true,
@@ -121,7 +121,7 @@ Vue.use(VModal, {
 Dialog is a simplified version of the modal which has most parameters set by default and is useful for quick prototyping, alerts, etc. Dialog is merely an example of how easy it is to create modals that fit your project needs. Nevertheless, you can use it if you set `dialog: true` in plugin configuration:
 
 ```js
-Vue.use(VModal, { dialog: true })
+app.use(VModal, { dialog: true })
 ```
 
 And include this component in your project:

docs/Other.md

@@ -10,11 +10,11 @@ Please consider sponsoring this project through [Github Sponsorship](https://git
 # Clone repo
 git clone https://github.com/febe95/vue-js-modal.git
 
-# Run unit tests
-npm run unit
+# Run tests
+npm run test
 
 # Run linter
-npm run lint
+npm run lint:js
 
 # Build main library for client & SSR
 cd vue-js-modal

docs/Usage.md

@@ -6,12 +6,12 @@ sidebarDepth: 2
 
 ## Configuration
 
-Configuration options can be passed as a second argument to `Vue.use`. 
+Configuration options can be passed as a second argument to `app.use`. 
 
 ```js
 import VModal from 'vue-js-modal'
 
-Vue.use(VModal, { ... })
+app.use(VModal, { ... })
 ```
 
 ####  `dialog: Boolean` 
@@ -27,7 +27,7 @@ Enables [dialogs](Intro#dialogs).
 Changes component name from "Modal" to any other string value. It is useful when there is already a global "modal" component.
 
 ```js
-Vue.use(VModal, { componentName: 'Foo' })
+app.use(VModal, { componentName: 'Foo' })
 ```
 ```html
 <foo name="example">This is a modal</foo>
@@ -42,7 +42,7 @@ Vue.use(VModal, { componentName: 'Foo' })
 Default properties that are injected into dynamic modals. 
 
 ```js
-Vue.use(VModal, { dynamicDefaults: { draggable: true, resizable: true } })
+app.use(VModal, { dynamicDefaults: { draggable: true, resizable: true } })
 ```
 
 ## API