Merge pull request #9 from versx/develop

Release 1.1

.gitignore

@@ -106,4 +106,8 @@ dist
 # No main configs
 config.json
 
-logs
+# No logs
+logs
+
+# No screenshots
+screenshots

README.md

@@ -2,11 +2,24 @@
 
 To be used with RealDeviceMap macless solution Kevin.  
 
-1.) Install dependencies `npm install`  
-2.) Copy config `cp src/config.example.json src/config.json`  
-3.) Fill out `vi src/config.json`  
-4.) Run `npm run start`  
+Central repository for macless client configurations without having to keep track of multiple remote configs and urls. Assign different configurations to different devices and different backends (RealDeviceMap / Lorgnette). When devices connect for the first time, if they don't exist they are created, if they don't have a config assigned, it will try to auto-assign it a default config if one exists.  
+You can also pre-create devices and assign configs yourself if needed.  
 
+## Features  
+- Custom config assignments
+- Screenshot preview
+- Device logging
+- Device endpoint tooling
+- and more...
+
+## Installation
+1.) Clone repository `git clone https://github.com/versx/DeviceConfigManager`  
+2.) Install dependencies `npm install`  
+3.) Copy config `cp src/config.example.json src/config.json`  
+4.) Fill out config `vi src/config.json`  
+5.) Run `npm run start`  
+
+## PM2 (recommended)
 Once everything is setup and running appropriately, you can add this to PM2 ecosystem.config.js file so it is automatically started:  
 ```
 module.exports = {
@@ -24,3 +37,7 @@ module.exports = {
   ]
 };
 ```
+
+## TODO  
+- Support for other macless client provider configs with custom predefined configuration keys.  
+- Localization.  

package.json

@@ -12,6 +12,7 @@
   "license": "ISC",
   "dependencies": {
     "express": "^4.17.1",
+    "multer": "^1.4.2",
     "mustache": "^4.0.1",
     "mustache-express": "^1.3.0",
     "mysql": "^2.18.1"