diff --git a/README.md b/README.md index 8fa9c69..5d2e430 100644 --- a/README.md +++ b/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... +}); +``` + diff --git a/package.json b/package.json index 6a415de..7b2a354 100644 --- a/package.json +++ b/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": {