From c2d64ba39ae8da5be50623226c6ea1aeb90b4cca Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Thu, 31 Jan 2019 00:46:42 +0100 Subject: [PATCH] fix(readme): update --- README.md | 37 ++++++++++++++++--------------------- npmextra.json | 12 +++++++++++- package.json | 4 ++-- 3 files changed, 29 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 053d9ee..a45a0fc 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,19 @@ -# smartsocket +# @pushrocks/smartsocket +easy and secure websocket communication -easy and secure websocket communication, TypeScript ready - -## Availabililty - -[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartsocket) -[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartsocket) -[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartsocket) -[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartsocket/) +## Availabililty and Links +* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartlog) +* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsocket) +* [github.com (source mirror)](https://github.com/pushrocks/smartsocket) +* [docs (typedoc)](https://pushrocks.gitlab.io/smartsocket/) ## Status for master - -[![build status](https://GitLab.com/pushrocks/smartsocket/badges/master/build.svg)](https://GitLab.com/pushrocks/smartsocket/commits/master) -[![coverage report](https://GitLab.com/pushrocks/smartsocket/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartsocket/commits/master) -[![npm downloads per month](https://img.shields.io/npm/dm/smartsocket.svg)](https://www.npmjs.com/package/smartsocket) -[![Dependency Status](https://david-dm.org/pushrocks/smartsocket.svg)](https://david-dm.org/pushrocks/smartsocket) -[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartsocket/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartsocket/master/dependencies/npm) -[![bitHound Code](https://www.bithound.io/github/pushrocks/smartsocket/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartsocket) -[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) -[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) +[![build status](https://gitlab.com/pushrocks/smartsocket/badges/master/build.svg)](https://gitlab.com/pushrocks/smartsocket/commits/master) +[![coverage report](https://gitlab.com/pushrocks/smartsocket/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartsocket/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartlog.svg)](https://www.npmjs.com/package/@pushrocks/smartlog) +[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartlog/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartlog) +[![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 @@ -108,9 +103,9 @@ mySmartsocketClient.serverCall('function', functionCallData).then(functionRespon > `data` is always a js object that you can design for your specific needs. > It supports buffers for large binary data network exchange. -For further information read the linked docs at the top of this README. +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) +| 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://push.rocks) +[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com) diff --git a/npmextra.json b/npmextra.json index ffa7e25..1e76e1f 100644 --- a/npmextra.json +++ b/npmextra.json @@ -1,5 +1,15 @@ { - "gitzone": {}, + "gitzone": { + "module": { + "githost": "gitlab.com", + "gitscope": "pushrocks", + "gitrepo": "smartsocket", + "shortDescription": "easy and secure websocket communication", + "npmPackagename": "@pushrocks/smartlog", + "license": "MIT", + "projectDomain": "push.rocks" + } + }, "npmci": { "npmGlobalTools": [], "npmAccessLevel": "public" diff --git a/package.json b/package.json index cc3a25b..afd4dd4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@pushrocks/smartsocket", "version": "1.1.24", - "description": "easy and secure websocket communication, TypeScript ready", + "description": "easy and secure websocket communication", "main": "dist/index.js", "typings": "dist/index.d.ts", "scripts": { @@ -39,4 +39,4 @@ "@types/node": "^10.12.19" }, "private": false -} +} \ No newline at end of file