Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jensrott committed Oct 17, 2019
1 parent 100cdd0 commit 721d81b
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 721d81b

Please sign in to comment.