Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update README

  • Loading branch information...
commit 6f0df7c01fc96dcbcbab16ec4f4a24a8322cb99e 1 parent 225a8b9
@bkeepers bkeepers authored
Showing with 15 additions and 9 deletions.
  1. +15 −9 README
View
24 README
@@ -2,6 +2,21 @@
acts_as_audited is an ActiveRecord extension that logs all changes to your models in an audits table.
+== Installation
+
+* Install the plugin into your rails app
+ If you are using Rails 2.1:
+
+ script/plugin install git://github.com/collectiveidea/acts_as_audited.git
+
+ For versions prior to 2.1:
+
+ git clone git://github.com/collectiveidea/acts_as_audited.git vendor/plugins/acts_as_audited
+
+* Generate the migration
+ script/generate audited_migration add_audits_table
+ rake db:migrate
+
== Auditing in Rails
If you're using acts_as_audited within Rails, you can simply declare which models should be audited. acts_as_audited can also automatically record the user that made the change if your controller has a <tt>current_user</tt> method.
@@ -24,15 +39,6 @@ To get auditing outside of Rails, or to customize which fields are audited withi
See http://opensoul.org/2006/07/21/acts_as_audited for more information.
-== Installation
-
-# Install the plugin into your rails app
- script/plugin install http://source.collectiveidea.com/public/rails/plugins/acts_as_audited
-
-# Generate the migration
- script/generate audited_migration add_audits_table
- rake db:migrate
-
== Caveats
Auditing with user support depends on Rails' caching mechanisms, therefore auditing isn't enabled during development mode. To test that auditing is working, start up your app in production mode, or change the following options in config/environments/environment.rb:
Please sign in to comment.
Something went wrong with that request. Please try again.