From e125628bcb7f41aa96d320c351fb517858edb667 Mon Sep 17 00:00:00 2001 From: "Angel N. Sciortino" Date: Wed, 24 Jun 2009 10:25:53 -0500 Subject: [PATCH] documentation --- README.markdown | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index 0354c9e..7bb4272 100644 --- a/README.markdown +++ b/README.markdown @@ -8,9 +8,7 @@ To generate the ScheduleFu migrations, run: rake db:migrate:schedule_fu -Below is a diagram of the models. The database diagram can be found in docs/database.png along with the original Dia file. - -## Tables +### Tables * calendars: distinct calendar that can be associated with your own models * calendar_recurrences: specific information on particular recurring dates @@ -20,12 +18,15 @@ Below is a diagram of the models. The database diagram can be found in docs/dat year before or after any date used in an event. * calendar_event_dates: a view that has a row for each date included in the event, original or modified information if a column was modified (time, description, etc), plus some additional informational columns -## Informational columns in calendar_event_dates +### Informational columns in calendar_event_dates * added: true if this date was added as a mod and not in the original event * modified: for dates that are included in the original event but have been modified (time, description, etc) * removed: true if this particular date was removed. There are named scopes in calendar_event_dates for :removed and :not_removed +### Database diagram +The database diagram can also be found in docs/database.png along with the original Dia file. + ![database.png](http://angelic.github.com/schedule_fu/database.png) This plugin borrows a lot from [acts_as_calendar](http://github.com/dball/acts_as_calendar)