@@ -3,4 +3,40 @@ TimelineFu Easily build timelines, much like GitHub's news feed. +Requirements +============ + +You'll need a TimelineEvent class, which TimelineFu will use. The name is hard-coded. + +Your TimelineEvent model will receive the following parameters in #create! + +* event_type +* target +* secondary_target +* actor + +It is your responsibility as the developer to correctly associate the objects +to your columns (or however you're storing them). You could associate +polymorphically using this: + + class TimelineEvent < ActiveRecord::Base + belongs_to :target, :polymorphic => true + belongs_to :secondary_target, :polymorphic => true + belongs_to :actor, :polymorphic => true + end + +For each object that can be a target of events, make it an event target: + + class Commit < ActiveRecord::Base + acts_as_event_target + end + + class Comment < ActiveRecord::Base + acts_as_event_target + end + + class Repository < ActiveRecord::Base + acts_as_event_target + end + Copyright (c) 2008 James Golick, released under the MIT license README ef9ec1fc4be8291ba3668cb8d97ee97f7aa76c19 François Beausoleil francois@teksol.info http://github.com/francois/timeline_fu/commit/e6d0db3d7ea709515231848ed0be418984bff642 e6d0db3d7ea709515231848ed0be418984bff642 2008-12-09T10:48:31-08:00 2008-12-09T10:48:31-08:00 More extensive documentation cd42434b6cd3aac9f4dd8a9c55f9bdb610271b9f François Beausoleil francois@teksol.info