README.rdoc in track_changes-1.0.0.pre3 vs README.rdoc in track_changes-1.0.0
- old
+ new
@@ -1,9 +1,36 @@
= track_changes
TrackChanges is a Rails engine to facilitate tracking changes made to your
models.
+== Release Notes
+
+Version 1.0 is a major change. This gem has been re-written from scratch as a
+Rails 3.0 engine. You will need to take additional steps to upgrade from
+versions prior to 1.0.
+
+=== General Upgrade Notes:
+
+* You no longer need to <tt>include TrackChanges</tt> in your controllers.
+* Additional arguments such as <tt>:only</tt>, and <tt>:except</tt> are no longer accepted in controllers
+* Any model that specifies <tt>track_changes</tt> will always have an Audit created on updates.
+* The revert capability is no longer available. This feature may return in the future.
+
+=== Specific Upgrade Instructions:
+
+* Update your <tt>Gemfile</tt>
+* Remove all occurences of <tt>include TrackChanges</tt> from your controllers
+* Remove your existing Audit class in <tt>RAILS_ROOT/app/models</tt>, this class is now part of the engine
+* Modify any calls to <tt>track_changes</tt> to remove additional arguments
+* Modify your <tt>RAILS_ROOT/config/track_changes_configuration</tt> to the following:
+
+ # Use whatever call you need to find the default user to be used if
+ # current_user is not set in your controller.
+ TrackChanges::Configuration::DEFAULT_USER_FINDER = Proc.new {
+ User.where(:login => "admin")
+ }
+
== Why?
I originally looked at the available auditing solutions and it appeared that
most of them were not thread-safe.