diff --git a/README.md b/README.md index 7be1164..b831d8c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ -# nodehash +# @pushrocks/smarthash +simplified access to node hash functions -simplifies access to node hash functions. TypeScript Ready +## 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 - -[![build status](https://gitlab.com/pushrocks/nodehash/badges/master/build.svg)](https://gitlab.com/pushrocks/nodehash/commits/master) +## 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-standard-brightgreen.svg)](http://standardjs.com/) ## Usage @@ -36,3 +46,8 @@ let hashString = nodehash.sha256FromStringSync("some weird random string"); ``` 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) diff --git a/npmextra.json b/npmextra.json index 4ff49cf..49f106b 100644 --- a/npmextra.json +++ b/npmextra.json @@ -1,5 +1,15 @@ { + "gitzone": { + "module": { + "githost": "gitlab.com", + "gitscope": "pushrocks", + "gitrepo": "smarthash", + "shortDescription": "simplifies access to node hash functions", + "npmPackagename": "@pushrocks/smarthash", + "license": "MIT" + } + }, "npmci": { "npmAccessLevel": "public" } -} \ No newline at end of file +} diff --git a/package.json b/package.json index 54f11b8..9e577f0 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@pushrocks/smarthash", "version": "2.0.1", "private": false, - "description": "simplifies access to node hash functions", + "description": "simplified access to node hash functions", "main": "dist/index.js", "typings": "dist/index.d.ts", "scripts": { @@ -14,6 +14,8 @@ "url": "git+https://github.com/pushrocks/nodehash.git" }, "keywords": [ + "pushrocks", + "typescript", "hash", "node", "sha256", @@ -38,4 +40,4 @@ "@types/through2": "^2.0.34", "through2": "^3.0.0" } -} +} \ No newline at end of file