diff --git a/README.md b/README.md index 87fa12d7dc05b23aca70fbad03a2dd98f76eb46c..c75e8c02b1f533ffb0cb741df3b8f669976d0eb6 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ Provided components: 9. [Episode](#episode) 1. [Episode Detail Component](#episode-detail-component) 10. [Category](#category) - 1. [Category List Component](#category-list-component) + 1. [Category List Component](#category-list-component) 3. [Progressive Web App](#progressive-web-app) 1. [Service Worker](#service-worker) 2. [Manifest](#manifest) @@ -435,32 +435,36 @@ If these steps do not work as described you'll need to ensure that either your c ### Install ```bash -npm install +make init.dev ``` +Now edit the `settings.json` located in the `config` folder. + ### Run To start the development server execute ```bash -./run.sh +make run ``` -or +## Production + +Before building the production bundle, initialize the app environment. ```bash -./run.sh dev +make init.app ``` -## Production +Then edit the `settings.json` located in the `config` folder. To build the components for production run ```bash -./run.sh build +make dist ``` -The resulting build artifacts are located in `public/build`. +The resulting build artifacts are located in `dist`. Now include the bundle in your theme, template, dependency management system or however your website is organized: