add better README
This commit is contained in:
parent
13c001c48a
commit
39835a4d27
22
README.md
22
README.md
@ -1,6 +1,24 @@
|
||||
# smartpath
|
||||
offers smart ways to handle paths
|
||||
|
||||
## Status
|
||||
## Availabililty
|
||||
[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartpath)
|
||||
[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartpath)
|
||||
[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartpath)
|
||||
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartpath/)
|
||||
|
||||
## Documentation
|
||||
## Status for master
|
||||
[![build status](https://GitLab.com/pushrocks/smartpath/badges/master/build.svg)](https://GitLab.com/pushrocks/smartpath/commits/master)
|
||||
[![coverage report](https://GitLab.com/pushrocks/smartpath/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartpath/commits/master)
|
||||
[![npm downloads per month](https://img.shields.io/npm/dm/smartpath.svg)](https://www.npmjs.com/package/smartpath)
|
||||
[![Dependency Status](https://david-dm.org/pushrocks/smartpath.svg)](https://david-dm.org/pushrocks/smartpath)
|
||||
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartpath/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartpath/master/dependencies/npm)
|
||||
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartpath/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartpath)
|
||||
[![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
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
|
||||
|
Loading…
Reference in New Issue
Block a user