#encoding: utf-8

= rholidays

Rholidays ermittelt Ferientermine (zum Beispiel Sommerferien in Bayern im Jahr 2011)

== Unterstützung dieses Projekts

Dieses Gem kann frei verwendet werden. Um die weitere Entwicklung und Aktualisierungen zu gewährleisten, kann dieses Projekt per Bitcoin unterstützt werden - Adresse hierfür: 1H6n4m7rJzMmdMspmfkAxuX79tsZnGkN94

== Features

* Liste der unterstützten Länder
* Liste der definierten Regionen (in Deutschland die Bundesländer) je Land
* Liste der Ferienarten je Land
* Liste der Ferienarten je Land und nur für bestimmte Region (z. B. Hessen)
* Ermitteln eines spezifischen Ferientyps (z.B. Sommerferien Bayern in Deutschland für 2011)
* Momentan sind die Länder Deutschland und Österreich implementiert

== Beispiele

require 'rubygems'
require 'rholidays'

# Sommerferien 2011 in Berlin (Deutschland)
f = Holidays.new(2011, :de, :berlin, :sommer)
f.days #=> Array mit allen Ferientagen (als Date-Objekte)
# inkl. der enthaltenen Samstagen und Sonntagen
#
# Weihnachtsferien 2011 in Kärnten (Österreich)
f = Holidays.new(2011, :at, :kaernten, :weihnachten)
f.days #=> Array mit Ferientagen (s. o.)
#
# nicht vorhandene Ferien oder zu weit in der Zukunft liegend:
f = Holidays.new(2011, :de, :bayern, :western)
#=> ArgumentError exception
#
f = Holidays.new(2030, :de, :bayern, :ostern)
#=> ArgumentError exception
#
# implementierte Laender
laender = Holidays.countries #=> [:de,:at]
#
# Regionen:
regionen = Holidays.regions(:de)
#=> [:baden_wuerttemberg, :bayern, ... ]
#
# Ferienarten für ein Land:
ferienarten = Holidays.holiday_types(:de)
#=> [:winter, :ostern, :pfingsten, :sommer, :herbst, :weihnachten]
# Ferienarten nur fuer eine Region (kann anders als fuer andere Regionen sein)
ferienarten = Holidays.holiday_types(:de, :hessen)
#=> [:ostern, :sommer, :herbst, :weihnachten]

== Installation

* gem install rholidays

== Autor

Thomas Preymesser ([email protected])


== Lizenz

(The MIT License)

Copyright (c) 2011 FIXME (author's name)

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.