From 2d06a66b9b79e35586b38134f1a3ad5689487551 Mon Sep 17 00:00:00 2001 From: Eugene Diachkin Date: Tue, 9 Mar 2021 15:19:38 +0300 Subject: [PATCH] Add a note on calendar names to README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 426352a..9eb48ac 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,11 @@ gem "business", "~> 2.0" Get started with business by creating an instance of the calendar class, that accepts a hash that specifies which days of the week are considered working days, which days are holidays and which are extra working dates. +Additionally each calendar instance can be given a name. This can come in handy if you use multiple calendars. + ```ruby calendar = Business::Calendar.new( + name: 'my calendar', working_days: %w( mon tue wed thu fri ), holidays: ["01/01/2014", "03/01/2014"], # array items are either parseable date strings, or real Date objects extra_working_dates: [nil], # Makes the calendar to consider a weekend day as a working day.