mirror of
https://github.com/holidayapi/holidayapi-ruby.git
synced 2025-06-21 12:36:34 +00:00
Fixed up README
This commit is contained in:
parent
6d95a482ec
commit
56201d0311
1 changed files with 32 additions and 0 deletions
32
README.md
32
README.md
|
@ -1,2 +1,34 @@
|
|||
# ruby-holidayapi
|
||||
Official Ruby library for Holiday API
|
||||
|
||||
## Installation
|
||||
|
||||
```shell
|
||||
gem install ruby-holidayapi
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```ruby
|
||||
require 'ruby-holidayapi'
|
||||
|
||||
var HolidayAPI = require('node-holidayapi');
|
||||
var hapi = new HolidayAPI('_YOUR_API_KEY').v1;
|
||||
|
||||
hapi = Holiday::V1('_YOUR_API_KEY_');
|
||||
|
||||
parameters = {
|
||||
// Required
|
||||
'country' => 'US',
|
||||
'year' => 2016,
|
||||
// Optional
|
||||
// 'month' => 7,
|
||||
// 'day' => 4,
|
||||
// 'previous' => true,
|
||||
// 'upcoming' => true,
|
||||
// 'public' => true,
|
||||
// 'pretty' => true,
|
||||
}
|
||||
|
||||
response = hapi.holiday(parameters)
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue