Browse files

Oh, and one last thing...

  • Loading branch information...
1 parent a1ab03a commit 421bb685242758d640cb5a32fb4922a96330b820 @webmat webmat committed Feb 20, 2009
Showing with 14 additions and 1 deletion.
  1. +14 −1 README.rdoc
@@ -7,10 +7,11 @@ Easily build timelines, much like GitHub's news feed.
TimelineFu requires you to have a TimelineEvent model.
The simplest way is to use the generator.
- $ script/generate timeline_fu
+ $ script/generate timeline_fu && rake db:migrate
exists db/migrate
create db/migrate/20090333222034_create_timeline_events.rb
create app/models/timeline_event.rb
+ # Migration blabber...
Next step is to determine what generates an event in your various models.
@@ -88,6 +89,18 @@ The generated model stores most of its info as polymorphic relationships.
belongs_to :secondary_subject, :polymorphic => true
+== How you actually get your timeline
+To get your timeline you'll probably have to create your own finder SQL or scopes
+(if your situation is extremely simple).
+TimelineFu is not currently providing anything to generate your timeline because
+different situations will have wildly different requirements. Like access control
+issues and actually just what crazy stuff you're cramming in that timeline.
+We're not saying it can't be done, just that we haven't done it yet.
+Contributions are welcome :-)
== Get it
timeline_fu can be used as a plugin:

0 comments on commit 421bb68

Please sign in to comment.