fix(readme): add

npmextra.json

@@ -14,4 +14,4 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
   }
-}
+}

package.json

@@ -23,4 +23,4 @@
   "dependencies": {
     "@pushrocks/smartpromise": "^2.0.5"
   }
-}
+}

readme.md

@@ -0,0 +1,26 @@
+# @pushrocks/smartkey
+handle private/public key creation
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartkey)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartkey)
+* [github.com (source mirror)](https://github.com/pushrocks/smartkey)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartkey/)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/smartkey/badges/master/build.svg)](https://gitlab.com/pushrocks/smartkey/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartkey/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartkey/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartkey.svg)](https://www.npmjs.com/package/@pushrocks/smartkey)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartkey/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartkey)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

ts/index.ts

@@ -1,2 +1,2 @@
 export * from './smartkey.classes.smartkey';
-export * from './smartkey.classes.keypair';
+export * from './smartkey.classes.keypair';

ts/smartkey.classes.keypair.ts

@@ -3,34 +3,38 @@ import * as plugins from './smartkey.plugins';
 /**
  * represents a keypair
  */
-export class KeyPair  {
+export class KeyPair {
   // static
-  public static async createKeyPair (passphraseArg = ''): Promise<KeyPair> {
+  public static async createKeyPair(passphraseArg = ''): Promise<KeyPair> {
     const done = plugins.smartpromise.defer<KeyPair>();
-    plugins.crypto.generateKeyPair('rsa', {
+    plugins.crypto.generateKeyPair(
-      modulusLength: 4096,
+      'rsa',
-      publicKeyEncoding: {
+      {
-        type: 'spki',
+        modulusLength: 4096,
-        format: 'pem'
+        publicKeyEncoding: {
+          type: 'spki',
+          format: 'pem'
+        },
+        privateKeyEncoding: {
+          type: 'pkcs8',
+          format: 'pem',
+          cipher: 'aes-256-cbc',
+          passphrase: passphraseArg
+        }
       },
-      privateKeyEncoding: {
+      (err, publicKeyArg, privateKeyArg) => {
-        type: 'pkcs8',
+        // convey error
-        format: 'pem',
+        if (err) {
-        cipher: 'aes-256-cbc',
+          done.reject(err);
-        passphrase: passphraseArg
+          throw err;
+        }
+        const keyPairInstance = new KeyPair({
+          privateKey: privateKeyArg,
+          publicKey: publicKeyArg
+        });
+        done.resolve(keyPairInstance);
       }
-    }, (err, publicKeyArg, privateKeyArg) => {
+    );
-      // convey error
-      if (err) {
-        done.reject(err);
-        throw (err);
-      }
-      const keyPairInstance = new KeyPair({
-        privateKey: privateKeyArg,
-        publicKey: publicKeyArg
-      });
-      done.resolve(keyPairInstance);
-    });
     return done.promise;
   }
 
@@ -38,11 +42,8 @@ export class KeyPair  {
   public publicKey: string;
   public privateKey: string;
 
-  constructor(optionsArg: {
+  constructor(optionsArg: { privateKey: string; publicKey: string }) {
-    privateKey: string;
-    publicKey: string;
-  }) {
     this.privateKey = optionsArg.privateKey;
     this.publicKey = optionsArg.publicKey;
   }
-}
+}

ts/smartkey.classes.smartkey.ts

@@ -1,7 +1,6 @@
 import * as plugins from './smartkey.plugins';
 import { KeyPair } from './smartkey.classes.keypair';
 
-
 export class SmartKey {
   // instance
   public async getKeypair(passohrase?: string): Promise<KeyPair> {

ts/smartkey.plugins.ts

@@ -1,13 +1,9 @@
 // node native
 import * as crypto from 'crypto';
 
-export {
+export { crypto };
-  crypto
-};
 
 // @pushrocks scope
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export {
+export { smartpromise };
-  smartpromise
-};