README.md in increments-schedule-0.3.0 vs README.md in increments-schedule-0.4.0

- old
+ new

@@ -14,22 +14,46 @@ gem 'increments-schedule' ``` And then execute: - $ bundle +```bash +$ bundle +``` Or install it yourself as: - $ gem install increments-schedule +```bash +$ gem install increments-schedule +``` -## Usage +## APIs -* `Increments::Schedule.each_super_hanakin` -* `Increments::Schedule.each_pay_day` -* `Increments::Schedule.each_remote_work_day` -* `Increments::Schedule.each_normal_remote_work_day` -* `Increments::Schedule.each_special_remote_work_day` +### Predicate Methods + +* `Increments::Schedule.super_hanakin?(date)` +* `Increments::Schedule.pay_day?(date)` +* `Increments::Schedule.work_day?(date)` +* `Increments::Schedule.office_work_day?(date)` +* `Increments::Schedule.remote_work_day?(date)` +* `Increments::Schedule.normal_remote_work_day?(date)` +* `Increments::Schedule.special_remote_work_day?(date)` +* `Increments::Schedule.rest_day?(date)` +* `Increments::Schedule.weekend?(date)` +* `Increments::Schedule.holiday?(date)` + +### Enumeration Methods + +* `Increments::Schedule.each_super_hanakin(max_date = Date.today + 365)` +* `Increments::Schedule.each_pay_day(max_date = Date.today + 365)` +* `Increments::Schedule.each_work_day(max_date = Date.today + 365)` +* `Increments::Schedule.each_office_work_day(max_date = Date.today + 365)` +* `Increments::Schedule.each_remote_work_day(max_date = Date.today + 365)` +* `Increments::Schedule.each_normal_remote_work_day(max_date = Date.today + 365)` +* `Increments::Schedule.each_special_remote_work_day(max_date = Date.today + 365)` +* `Increments::Schedule.each_rest_day(max_date = Date.today + 365)` +* `Increments::Schedule.each_weekend(max_date = Date.today + 365)` +* `Increments::Schedule.each_holiday(max_date = Date.today + 365)` ## 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.