documentation updated v1.0.0
authorebelcrom <ebelcrom@gmail.com>
Sun, 1 Mar 2020 20:23:11 +0000 (21:23 +0100)
committerebelcrom <ebelcrom@gmail.com>
Sun, 1 Mar 2020 20:23:11 +0000 (21:23 +0100)
README.md
src/lib/lib.js
src/views/Settings.vue

index b04721395ee4caa62ea1eaae1fb89b92c858cb06..c4952bff4fbcdef89d9c6a88f3650d42e0330ea1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,50 @@
 # garnod-pwa.git
 
-## Project setup
+This is the garage node client application.
+
+## Getting started
+
+These instructions let get you a copy of the project and running on it your local machine.
+
+### Installing
+
+Get the project using git:
+
 ```
+git clone https://binomiant.duckdns.org/MpqU9XX8/garnod-pwa.git
+```
+
+Install required packages:
+
+```
+cd garnod-pwa.git
 npm install
 ```
 
-### Compiles and hot-reloads for development
+Compile (with hot-reload) for development by running
+
 ```
 npm run serve
+
+Change `publicPath` to `/` in `vue.config.js` if you experience problems.
 ```
 
-### Compiles and minifies for production
+Compile (minifies) for production by running
+
 ```
 npm run build
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+Your compiled output is located in the `dist` directory.
+
+You can use a GUI to compile and run the application in your browser:
+
+```
+vue ui
+```
+
+For a correct view without scrollable margins replace the meta section in `index.html`:
+
+```
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, minimal-ui">
+```
index f0bc4d4154ee87eb84213a727e3b8efd1fd61b24..679f5894065434f34cdbd17eb3dd16508c9e5114 100644 (file)
@@ -2,7 +2,7 @@ const url = 'https://binomiant.duckdns.org/mVk7Yr3k/v1';
 const prodStatus = '/status';
 const prodEvents = '/events';
 const prodControl = '/control';
-const prodNotification = '/test/notification';
+const prodNotification = '/notification';
 const testStatus = '/test/status';
 const testEvents = '/test/events';
 const testControl = '/test/control';
index ae173fa207908a12051c6ff7f0aca7597163b818..1653577b0a47c362f2cbc9415b33dc6f30aeb561 100644 (file)
@@ -83,14 +83,14 @@ export default {
           itemAction: this.setApiKeyInItem,
           switchAction: this.setApiKeyInSwitch,
           title: 'Production API-Key',
-          subtitle: 'Allows access on pruduction features',
+          subtitle: 'Allows access on production features',
         },
         {
           value: false,
           itemAction: this.setPushNotificationInItem,
           switchAction: this.setPushNotificationInSwitch,
           title: 'Push notification',
-          subtitle: 'Allows access on production features',
+          subtitle: 'Subscribes on open door push notification',
         },
         {
           value: false,