Contents

TB Events
===========

TB Events is an event and calendaring engine for Twice Baked.

Installation/Usage
------------------

1. Add the following to your Gemfile

        gem 'tb_core'
        gem 'tb_events'

2. Run ```bundle install```
3. Copy the database migrations in to your rails project

        rake railties:install:migrations

4. Run the database migrations ```rake db:migrate```
5. The defualt URL for the calendar page is ```/calendar```

Configruations
--------------

* Set the layout for the calendar pages (Defualt is layouts/spud/calendar)

        SpudEvents.configure do |config|
          config.calendar_layout = 'application'
        end

* Override the default calendar views by placing the corresponding views in the ```calendars``` and ```calendar_events``` view folders.
* Include the default calendar CSS by adding the following to your ```application.css``` file 

        /*
        ...
        *= require spud/events
        */

## View Helpers

TB Events comes with a handful of view helpers for generating calendars. See the Rdoc documentation for detailed information.

Return a calendar as an html table for the given date:

    spud_calendar_for_date(date)

Return a calendar for the given date, populated with event data:

    spud_calendar_for_events(events, date, opts)

Testing
-----------------

Spud uses RSpec for testing. Get the tests running with a few short commands:

1. Create and migrate the databases:
   
        rake db:create
        rake db:migrate

2. Load the schema in to the test database:

        rake app:db:test:prepare

3. Run the tests with RSpec

        rspec spec

After the tests have completed the current code coverage stats is available by opening ```/coverage/index.html``` in a browser.
    

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
tb_events-1.3.1	README.md
tb_events-1.3.0	README.md
tb_events-1.1.2	README.md
tb_events-1.2.0.beta1	README.md
tb_events-1.1.1	README.md