From 873fee33012d2a893af37172ad7c52d6336571e8 Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Tue, 25 May 2021 22:09:26 +0200 Subject: [PATCH] [docs] Updated readme on how to install plugins --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c8f5bc..844f5c4 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,29 @@ Be aware npm might not work. ### Configure Plugins -You can activate and deactive Plugins in `src/boot/plugins.ts`. -You have to set the name of the Plugin into `config.loadModules`. +#### Installing a plugin + +Simply add it as a dependency and install it, for example installing the `pricelist`-plugin: + +```sh +yarn add '@flaschengeist/pricelist' +yarn install +``` + +#### Enable / Disable a plugin + +After installing a plugin you will have to enable it, +this is done by adding it to the `plugin.config.js` file. +For the example above the file should look like: + +```js +module.exports = [ + // pricelist plugin: + '@flaschengeist/pricelist', +]; +``` + +Remember to rebuild the project ### Configure Backend @@ -49,7 +70,7 @@ This access needs to be configured in `src/config.ts'->config.baseURL ### Build the application -```bash +```sh yarn quasar build ```