-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): Populates read me with some info
- Loading branch information
Gonzalo Manrique
committed
Jul 11, 2017
1 parent
ceea240
commit c6dadb7
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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()); | ||
``` |