Merge pull request #53 from appy-one/improvement/readme-updates

readme updates

.gitignore

@@ -1,2 +1,3 @@
 node_modules
-.vscode
+.vscode
+*.acebase

README.md

@@ -2,10 +2,20 @@
 
 This repository is to setup an http endpoint for a local AceBase database instance. See [AceBase](https://www.npmjs.com/package/acebase) for more information about AceBase databases and usage.
 
+![AceBase server webmanager](./img/acebase-webmanager.png)
+
+![AceBase server Swagger UI](./img/acebase-swagger-ui.png)
+
 ## Getting started
 
 Install the *acebase-server* npm package: ```npm install acebase-server``` ([github](https://github.com/appy-one/acebase-server), [npm](https://www.npmjs.com/package/acebase-server))
 
+To test running an AceBase server with authentication on localhost:3000, execute the following commands
+* `cd ./node_modules/acebase-server`
+* `npm run test`
+* Open [http://localhost:3000](http://localhost:3000) in your browser. To sign into the webmanager, use db name `default`, username `admin` and the generated password displayed in your console output. The webmanager allows browsing your database content and performing updates.
+* Open [http://localhost:3000/docs](http://localhost:3000/docs) to open the Swagger UI that is enabled in development mode. All REST API methods are documented and can be executed here.
+
 ## Creating an AceBase server
 
 To launch an AceBase webserver using default settings

package.json

@@ -15,7 +15,7 @@
   "private": false,
   "repository": "github:appy-one/acebase-server",
   "scripts": {
-    "start": "node dist/esm/start.js DBNAME=default DBPATH=.. HOST=localhost PORT=3000 TXLOG=1 AUTH=1",
+    "start": "node dist/esm/start.js DBNAME=default DBPATH=. HOST=localhost PORT=3000 TXLOG=1 AUTH=1",
     "test": "set NODE_ENV=development && npm run start",
     "build": "npm run build:clean && npm run build:esm && npm run build:cjs && npm run build:packages && echo Done!",
     "build:clean": "rm -fr dist/*",