README.md in commercial_weeks-0.2.0 vs README.md in commercial_weeks-0.2.1
- old
+ new
@@ -20,10 +20,35 @@
$ gem install commercial_weeks
## Usage
-TODO: Write usage instructions here
+Computes start date and end date for week
+ CommercialWeeks.week_dates(week_num, year)
+
+Computes number of weeks in a year
+ CommercialWeeks.weeks_count(year)
+
+Compute first week of the year
+ CommercialWeeks.get_first_week(year=Time.now.year)
+
+Calculate weeks based the startign and ending weeks
+ CommercialWeeks.calculate_weeks(start_week, end_week, year)
+
+Calculate previous half year weeks
+ CommercialWeeks.previous_half_year_weeks(year)
+
+Calculate previous half year weeks
+ CommercialWeeks.next_half_year_weeks(year)
+
+Compute weeks for the year
+ CommercialWeeks.compute_weeks(year=Time.now.year)
+
+Computes week for the given date
+ CommercialWeeks.current_week(current_date)
+
+Compute weeks start date
+ CommercialWeeks.start_date_of_week(date)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.