Skip to content

Commit

Permalink
docs(readme): Populates read me with some info
Browse files Browse the repository at this point in the history
  • Loading branch information
Gonzalo Manrique committed Jul 11, 2017
1 parent ceea240 commit c6dadb7
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# harry-potter-names
Get random Harry Potter names.

## Install
Install with **npm**
```
npm install harry-potter-names --save
```
Or if you prefer **yarn**
```
yarn add harry-potter-names
```

## Usage

```javascript
let harryPotterNames = require('harry-potter-names');

// To get array of names
console.log(harryPotterNames.all);

// To get a random name
console.log(harryPotterNames.random());
```

0 comments on commit c6dadb7

Please sign in to comment.