deac/holidays
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated readme markdown

Browse source
This commit is contained in:
Alex Dunae 2008-12-30 11:31:54 -08:00
parent f0c8a54e9b
commit f8093ee712
1 changed files with 32 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,10 +1,10 @@
= Ruby Holidays Gem # Ruby Holidays Gem
A set of functions to deal with holidays in Ruby. A set of functions to deal with holidays in Ruby.
Extends Ruby's built-in Date class and supports custom holiday definition lists. Extends Ruby's built-in Date class and supports custom holiday definition lists.
=== Installation ### Installation
To install the gem from RubyForge: To install the gem from RubyForge:
@ -13,11 +13,8 @@ To install the gem from RubyForge:
Or, download the source <tt>.tgz</tt> file from http://rubyforge.org/holidays and Or, download the source <tt>.tgz</tt> file from http://rubyforge.org/holidays and
extract it somewhere in your include path. extract it somewhere in your include path.
=== Examples
For more information, see the notes at the top of the Holidays module. ### Using the Holidays class
==== Using the Holidays class
Get all holidays on April 25, 2008 in Australia. Get all holidays on April 25, 2008 in Australia.
date = Date.civil(2008,4,25) date = Date.civil(2008,4,25)
@ -46,7 +43,7 @@ Get informal holidays in February.
=> [{:name => 'Valentine\'s Day',...}] => [{:name => 'Valentine\'s Day',...}]
==== Extending Ruby's Date class ### Extending Ruby's Date class
Check which holidays occur in Iceland on January 1, 2008. Check which holidays occur in Iceland on January 1, 2008.
d = Date.civil(2008,7,1) d = Date.civil(2008,7,1)
@ -65,7 +62,7 @@ Lookup Canada Day in different regions.
d.holiday?(:fr) # France d.holiday?(:fr) # France
=> false => false
=== Credits and code ### Credits and code
* Project page: http://code.dunae.ca/holidays * Project page: http://code.dunae.ca/holidays
* Source: http://code.dunae.ca/svn/holidays * Source: http://code.dunae.ca/svn/holidays