Skip to content
This repository has been archived by the owner on Sep 20, 2019. It is now read-only.

Commit

Permalink
Spruced up readme, bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
joshtronic committed Aug 20, 2016
1 parent 221e130 commit 9b9d800
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
31 changes: 31 additions & 0 deletions README.md
@@ -1,2 +1,33 @@
# node-holidayapi
Official Node.js library for [Holiday API](https://holidayapi.com)

## Installation

```shell
npm install --save node-holidayapi
```

## Usage

```javascript
var hapi = require('node-holidayapi');
var Hapi = new HolidayAPI('_YOUR_API_KEY').v1;

var parameters = {
// Required
country: 'US',
year: 2016,
// Optional
// month: 7,
// day: 4,
// previous true,
// upcoming true,
// public: true,
// pretty: true,
};

var Hapi.holidays(parameters, function (err, data) {
// Insert awesome code here...
});
```

2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "node-holidayapi",
"version": "0.0.0",
"version": "1.0.0",
"description": "Official Node.js library for Holiday API",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 9b9d800

Please sign in to comment.