diff --git a/.vscode/settings.json b/.vscode/settings.json
index bdee587..e85392e 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -14,6 +14,9 @@
"[jsonc]": {
"editor.defaultFormatter": "vscode.json-language-features"
},
+ "[md]": {
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
+ },
"[vue]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
diff --git a/README.md b/README.md
index b8d01ef..51edd12 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
[](https://www.npmjs.com/package/@tenrok/vue-cron-editor-bootstrap)
[](https://github.com/tenrok/vue-cron-editor-bootstrap/blob/main/LICENSE)
-[](https://github.com/vuejs/vue)
+[](https://github.com/vuejs/vue)
[](https://github.com/tenrok/vue-cron-editor-bootstrap)
[](https://npmcharts.com/compare/@tenrok/vue-cron-editor-bootstrap?minimal=true)
[](https://tenrok.github.io/vue-cron-editor-bootstrap/)
@@ -13,36 +13,49 @@ Inspired by https://github.com/karoletrych/vue-cron-editor
# Requirements
- Vue ^2.0
-- @tenrok/bootstrap-vue ^2.23.2
+- Bootstrap-Vue ^2.23.1
-# Installation
+# Quickstart
+
+Install using
```
npm install @tenrok/vue-cron-editor-bootstrap --save
```
-# Usage
+Then, initalize the plugin in the starting point of your app (most likely src/main.js):
+```js
+// main.js
+import { Plugin } from '@tenrok/vue-cron-editor-bootstrap'
+Vue.use(Plugin)
```
+
+The components will be registered globally and you can use them immediately.
+
+You can also import individual components into .vue SFC (Single File Component):
+
+```html
+