README.md.erb

[![Gem Version](http://img.shields.io/gem/v/increments-schedule.svg?style=flat)](http://badge.fury.io/rb/increments-schedule)
[![Build Status](https://travis-ci.org/increments/increments-schedule.svg?branch=master&style=flat)](https://travis-ci.org/increments/increments-schedule)

# Increments::Schedule

**Increments::Schedule** is a convenient library for checking Increments' company schedule.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'increments-schedule'
```

And then execute:

```bash
$ bundle
```

Or install it yourself as:

```bash
$ gem install increments-schedule
```

## APIs

### Predicate Methods

<%=
methods = Increments::Schedule.public_instance_methods.select do |method|
  method.to_s.end_with?('?') && method != :winter_vacation?
end.sort

methods.map do |method|
  "* `Increments::Schedule.#{method}(date = Date.today)`"
end.join("\n")
%>

### Enumeration Methods

<%=
methods = Increments::Schedule.public_instance_methods.select do |method|
  method.to_s.start_with?('each_') && method != :each_winter_vacation
end.sort

methods.map do |method|
  "* `Increments::Schedule.#{method}(max_date = Date.today + 365)`"
end.join("\n")
%>

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

1. Fork it ( https://github.com/[my-github-username]/increments-schedule/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request