version bump. description updated

Author: webmaxru

README.md

@@ -1,4 +1,6 @@
-### Use the power of Neo4j graph database in your Angular app
+### Neo4j Bolt driver wrapper for Angular
+
+Use Neo4j Bolt driver for JavaScript from your Angular application. A special browser version of the driver supports connecting to Neo4j over WebSockets.
 
 #### Installation
 
@@ -19,7 +21,7 @@ export class AppModule { }
 ```
 
 ### Usage
-The module includes a service and a design-free component utilizing this service: login form and query form. You are welcome to use this component as a foundation for your custom one.
+The module includes a service and a design-free component using this service: login form and query form. You are welcome to use this component as a foundation for your custom one.
 
 The fastest way to test everything:
 
@@ -32,9 +34,9 @@ Use the service in your own component:
 ```javascript
   import { AngularNeo4jService } from './angular-neo4j.service';
   ...
-  constructor(pprivate neo4j: AngularNeo4jService) {}
+  constructor(private neo4j: AngularNeo4jService) {}
 ```
-- `connect( url: string, username: string, password: string, encrypted?: boolean )` - Connect to your Neo4j instance
+- `connect( url: string, username: string, password: string, encrypted?: boolean )` - Connect to your Neo4j instance. Returns a promise with a driver instance.
 ```javascript
 
   const url = 'bolt://localhost:7687';
@@ -55,7 +57,7 @@ Use the service in your own component:
         }
       });
 ```
-- `run( query: string, params?: object)` - Run the query with parameters. Returns array of records.
+- `run( query: string, params?: object)` - Run the query with parameters. Returns a promise with array of records.
 ```javascript
 
   const query = 'MATCH (n:USER {name: {name}}) RETURN n';
@@ -65,11 +67,15 @@ Use the service in your own component:
       console.log(res);
     });
 ```
-- `disconnect()` - Close the active driver
+- `disconnect()` - Close the active driver.
 ```javascript
   this.neo4j.disconnect()
 ```
 
+### Note on security
+
+Do not hardcode your Neo4j username and password in the Angular app - always use login form to authenticate.
+
 ## License
 
 MIT © [Maxim Salnikov](mailto:[email protected])

package.json

@@ -1,6 +1,11 @@
 {
+  "author": {
+    "name": "Maxim Salnikov",
+    "email": "[email protected]"
+  },
   "name": "angular-neo4j",
-  "version": "0.0.0",
+  "description": "Neo4j Bolt driver wrapper for Angular",
+  "version": "0.6.0",
   "license": "MIT",
   "scripts": {
     "ng": "ng",
@@ -10,7 +15,8 @@
     "lint": "ng lint",
     "e2e": "ng e2e",
     "build:lib": "gulp --gulpfile gulpfile.lib.js",
-    "version": "sync-json -v --property version --source package.json src/lib/package.json"
+    "version":
+      "sync-json -v --property version --source package.json src/lib/package.json"
   },
   "private": true,
   "dependencies": {

src/lib/package.json

@@ -1,12 +1,14 @@
 {
   "author": {
-    "name": "[email protected]"
+    "name": "Maxim Salnikov",
+    "email": "[email protected]"
   },
   "bugs": {
     "url": "https://github.com/webmaxru/angular-neo4j/issues"
   },
   "name": "angular-neo4j",
-  "version": "0.1.0",
+  "description": "Neo4j Bolt driver wrapper for Angular",
+  "version": "0.6.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/webmaxru/angular-neo4j.git"
@@ -18,10 +20,12 @@
   "es2015": "./esm2015/angular-neo4j.js",
   "module": "./esm5/angular-neo4j.es5.js",
   "typings": "./angular-neo4j.d.ts",
+  "dependencies": {
+    "neo4j-driver": "^1.6.0"
+  },
   "peerDependencies": {
     "@angular/core": "^5.0.0",
     "@angular/common": "^5.0.0",
-    "@angular/forms": "^5.0.0",
-    "neo4j-driver": "^1.6.0"
+    "@angular/forms": "^5.0.0"
   }
 }