diff --git a/package-lock.json b/package-lock.json
index 3c79bb2..16f75c2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -202,12 +202,12 @@
       }
     },
     "@pushrocks/smartjson": {
-      "version": "3.0.8",
-      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartjson/-/smartjson-3.0.8.tgz",
-      "integrity": "sha512-EjC3611RSZaZmK+nXxXrYDBxdxYWtrxjOrZtQzbYn0yM33KSCH0sLIAG8B2wYZVAOj4A2pC8mVxFSJ1w3iRFHg==",
+      "version": "3.0.9",
+      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartjson/-/smartjson-3.0.9.tgz",
+      "integrity": "sha512-KAWMUpUY5a5WWRxlE0YQiJhbEQ9wOUWs/Iyv+S1cxYx//javChKai6kwvRMVEfEn/xRcFqGgSGJW5RspcL0s/g==",
       "requires": {
         "@types/fast-json-stable-stringify": "^2.0.0",
-        "fast-json-stable-stringify": "^2.0.0",
+        "fast-json-stable-stringify": "^2.1.0",
         "lodash.clonedeep": "^4.5.0"
       }
     },
@@ -497,9 +497,9 @@
       "dev": true
     },
     "@types/node": {
-      "version": "12.12.11",
-      "resolved": "https://verdaccio.lossless.one/@types%2fnode/-/node-12.12.11.tgz",
-      "integrity": "sha512-O+x6uIpa6oMNTkPuHDa9MhMMehlxLAd5QcOvKRjAFsBVpeFWTOPnXbDvILvFgFFZfQ1xh1EZi1FbXxUix+zpsQ=="
+      "version": "12.12.17",
+      "resolved": "https://verdaccio.lossless.one/@types%2fnode/-/node-12.12.17.tgz",
+      "integrity": "sha512-Is+l3mcHvs47sKy+afn2O1rV4ldZFU7W8101cNlOd+MRbjM4Onida8jSZnJdTe/0Pcf25g9BNIUsuugmE6puHA=="
     },
     "@types/through2": {
       "version": "2.0.34",
@@ -855,9 +855,9 @@
       }
     },
     "fast-json-stable-stringify": {
-      "version": "2.0.0",
-      "resolved": "https://verdaccio.lossless.one/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz",
-      "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I="
+      "version": "2.1.0",
+      "resolved": "https://verdaccio.lossless.one/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz",
+      "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw=="
     },
     "figures": {
       "version": "3.1.0",
diff --git a/package.json b/package.json
index ce0f143..acd1c72 100644
--- a/package.json
+++ b/package.json
@@ -33,12 +33,12 @@
     "@gitzone/tsrun": "^1.2.8",
     "@gitzone/tstest": "^1.0.28",
     "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^12.12.11",
+    "@types/node": "^12.12.17",
     "tslint": "^5.20.1",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartjson": "^3.0.8",
+    "@pushrocks/smartjson": "^3.0.9",
     "@pushrocks/smartpromise": "^3.0.6",
     "@types/through2": "^2.0.34",
     "through2": "^3.0.1"
@@ -54,4 +54,4 @@
     "npmextra.json",
     "readme.md"
   ]
-}
+}
\ No newline at end of file
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..d3623ab
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,68 @@
+# @pushrocks/smarthash
+simplifies access to node hash functions
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarthash)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smarthash)
+* [github.com (source mirror)](https://github.com/pushrocks/smarthash)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smarthash/)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/smarthash/badges/master/build.svg)](https://gitlab.com/pushrocks/smarthash/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smarthash/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smarthash/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smarthash.svg)](https://www.npmjs.com/package/@pushrocks/smarthash)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smarthash/badge.svg)](https://snyk.io/test/npm/@pushrocks/smarthash)
+[![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
+
+We recommend the use of TypeScript for best in class intellisense.
+
+```typescript
+import * as smarthash from "smarthash";
+
+// ======
+// sha265
+// ======
+
+// from stream
+let readStream = fs.createReadStream("./somefile.txt")
+smarthash.sha256FromStream(readStream)
+    .then((resultString){
+        console.log(resultString); // prints hash of the file
+    });
+
+// from file
+smarthash.sha256FromFile("./somefile.txt")
+    .then((resultString){
+        console.log(resultString); // prints hash of the file
+    });
+
+// from string
+smarthash.sha256FromString("some weird random string")
+    .then((resultString){
+        console.log(resultString); // prints hash of the file
+    });
+
+let hashString = smarthash.sha256FromStringSync("some weird random string");
+
+// ===
+// md5
+// ===
+smarthash.md5FromString('hellothere').then(md5String = {
+    // do something with it here
+})
+```
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)