diff --git a/README.md b/README.md index 78d93a5..dff6001 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # bike-names + Micro library that returns names of famous bike brands + +[![npm version](https://img.shields.io/npm/v/bike-names.svg?style=flat-square)](https://www.npmjs.com/package/bike-names) +[![License](https://img.shields.io/npm/l/bike-names.svg?style=flat-square)](https://www.npmjs.com/package/bike-names) +[![npm downloads](https://img.shields.io/npm/dt/bike-names.svg?style=flat-square)](https://www.npmjs.com/package/bike-names) +[![travis build](https://img.shields.io/travis/jensrott/bike-names.svg?style=flat-square)](https://travis-ci.com/jensrott/bike-names) +[![codecov coverage](https://img.shields.io/codecov/c/github/jensrott/bike-names.svg?style=flat-square)](https://codecov.io/github/jensrott/bike-names) + +  +  + +# Install + +This package is distributed via npm: + +``` +$ npm install bike-names +``` + +  +  + +# Usage + +```javascript +const names = require('bike-names'); +const allNames = names.all; +const randomName = names.random(); +``` + +  +  + +# License + +MIT \ No newline at end of file