Readme formatting updates

This commit is contained in:
Alex Dunae 2008-12-30 11:40:21 -08:00
parent 36cefe2d49
commit a63b4cacec
3 changed files with 149 additions and 227 deletions

View file

@ -1,79 +0,0 @@
# Ruby Holidays Gem
A set of functions to deal with holidays in Ruby.
Extends Ruby's built-in Date class and supports custom holiday definition lists.
### Installation
To install the gem from RubyForge:
gem install holidays
Or, download the source <tt>.tgz</tt> file from http://rubyforge.org/holidays and
extract it somewhere in your include path.
### Using the Holidays class
Get all holidays on April 25, 2008 in Australia.
date = Date.civil(2008,4,25)
Holidays.on(date, :au)
=> [{:name => 'ANZAC Day',...}]
Get holidays that are observed on July 2, 2007 in British Columbia, Canada.
date = Date.civil(2007,7,2)
Holidays.on(date, :ca_bc, :observed)
=> [{:name => 'Canada Day',...}]
Get all holidays in July, 2008 in Canada and the US.
from = Date.civil(2008,7,1)
to = Date.civil(2008,7,31)
Holidays.between(from, to, :ca, :us)
=> [{:name => 'Canada Day',...}
{:name => 'Independence Day',...}]
Get informal holidays in February.
from = Date.civil(2008,2,1)
to = Date.civil(2008,2,15)
Holidays.between(from, to)
=> [{:name => 'Valentine\'s Day',...}]
### Extending Ruby's Date class
Check which holidays occur in Iceland on January 1, 2008.
d = Date.civil(2008,7,1)
d.holidays(:is)
=> [{:name => 'Nýársdagur'}...]
Lookup Canada Day in different regions.
d = Date.civil(2008,7,1)
d.holiday?(:ca) # Canada
=> true
d.holiday?(:ca_bc) # British Columbia, Canada
=> true
d.holiday?(:fr) # France
=> false
### Credits and code
* Project page: http://code.dunae.ca/holidays
* Source: http://code.dunae.ca/svn/holidays
* Docs: http://code.dunae.ca/holidays/doc
By Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2007-08.
Made on Vancouver Island.

View file

@ -6,8 +6,9 @@ Extends Ruby's built-in Date class and supports custom holiday definition lists.
=== Installation
To install the gem from RubyForge:
To install the gem from GitHub:
gem sources -a http://gems.github.com
gem install holidays
Or, download the source <tt>.tgz</tt> file from http://rubyforge.org/holidays and
@ -68,7 +69,7 @@ Lookup Canada Day in different regions.
=== Credits and code
* Project page: http://code.dunae.ca/holidays
* Source: http://code.dunae.ca/svn/holidays
* Source: http://github.com/alexdunae/holidays
* Docs: http://code.dunae.ca/holidays/doc
By Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2007-08.

View file

@ -35,7 +35,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
rdoc.options << '--all' << '--inline-source' << '--line-numbers'
rdoc.options << '--charset' << 'utf-8'
#rdoc.template = 'extras/rdoc_template.rb'
rdoc.rdoc_files.include('README')
rdoc.rdoc_files.include('README.rdoc')
rdoc.rdoc_files.include('data/SYNTAX')
rdoc.rdoc_files.include('lib/holidays/MANIFEST')
rdoc.rdoc_files.include('REFERENCES')
@ -57,7 +57,7 @@ spec = Gem::Specification.new do |s|
s.files = FileList["{lib}/**/*", "{data}/**/*", "*.rb"].to_a
s.test_files = FileList['test/defs/test*.rb'].exclude('test_helper.rb')
s.has_rdoc = true
s.extra_rdoc_files = ['README', 'data/SYNTAX', 'lib/holidays/MANIFEST', 'REFERENCES', 'CHANGELOG', 'LICENSE']
s.extra_rdoc_files = ['README.rdoc', 'data/SYNTAX', 'lib/holidays/MANIFEST', 'REFERENCES', 'CHANGELOG', 'LICENSE']
s.rdoc_options << '--all' << '--inline-source' << '--line-numbers' << '--charset' << 'utf-8'
end