From 32b26f21cd23217f5268d9e54d32871347023ce6 Mon Sep 17 00:00:00 2001 From: PhilKunz Date: Wed, 23 Nov 2016 12:44:31 +0100 Subject: [PATCH] improve README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index de9cb2b..a7b60f6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,22 @@ setups SSH quickly and in a painless manner > Attention: This is still alpha, so some things won't work, not all things are inplemented. +## Availabililty +[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartssh) +[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartssh) +[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartssh) +[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartssh/) +## Status for master +[![build status](https://gitlab.com/pushrocks/smartssh/badges/master/build.svg)](https://gitlab.com/pushrocks/smartssh/commits/master) +[![coverage report](https://gitlab.com/pushrocks/smartssh/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartssh/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/smartssh.svg)](https://www.npmjs.com/package/smartssh) +[![Dependency Status](https://david-dm.org/pushrocks/smartssh.svg)](https://david-dm.org/pushrocks/smartssh) +[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartssh/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartssh/master/dependencies/npm) +[![bitHound Code](https://www.bithound.io/github/pushrocks/smartssh/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartssh) +[![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/) +[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) ## Usage @@ -34,3 +49,5 @@ sshInstance.getKey({ // returns ssh key in the form sshKey, read more about the sshInstance.getKeys() // returns array of all available getKeys. Each key is in form of class sshKey ``` + +[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)