diff --git a/README.md b/README.md index 1f9fc44..8e95669 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,25 @@ -# smartgit is an easy wrapper for nodegit -a wrapper for git. This plugin does not use nodegit as nodegit appears to have too many bugs for now. +# smartgit +wrapper for git. -### Buildstatus/Dependencies +smartgit expects git to be installed on target machine. + +## Availabililty +[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartgit) +[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartgit) +[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartgit) +[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartgit/) + +## Status for master [![build status](https://gitlab.com/pushrocks/smartgit/badges/master/build.svg)](https://gitlab.com/pushrocks/smartgit/commits/master) -[![devDependency Status](https://david-dm.org/pushrocks/smartgit/dev-status.svg)](https://david-dm.org/pushrocks/smartgit#info=devDependencies) -[![Coverage Status](https://coveralls.io/repos/github/pushrocks/smartgit/badge.svg?branch=master)](https://coveralls.io/github/pushrocks/smartgit?branch=master) +[![coverage report](https://gitlab.com/pushrocks/smartgit/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartgit/commits/master) +[![Dependency Status](https://david-dm.org/pushrocks/smartgit.svg)](https://david-dm.org/pushrocks/smartgit) +[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartgit/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartgit/master/dependencies/npm) +[![bitHound Code](https://www.bithound.io/github/pushrocks/smartgit/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartgit) +[![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 -This plugin exposes some easified method wrappers for nodegit. -This limits options but reduces errors (TypeScript) and speeds up usage. - -Features: +## Features: * clone a git repo * init a new repo @@ -20,4 +29,14 @@ Features: * push changes * add/remove remotes -Tip: use [smartssh](https://npmjs.com/smartssh) to setup your SSH environment \ No newline at end of file +## Usage +We recommend the use of TypeScript for best in class intellisense + +```javascript +import * as smartgit from 'smartgit' + +``` + +Tip: use [smartssh](https://npmjs.com/smartssh) to setup your SSH environment + +[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)