Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Usage notes in readme.

  • Loading branch information...
commit 0e4b4b35f78ee490c1493d7642af94d3289eb0f7 1 parent 8a6f1d6
@EmFi EmFi authored Emery Finkelstein committed
Showing with 4 additions and 1 deletion.
  1. +4 −1 README
View
5 README
@@ -26,7 +26,10 @@ Declare <tt>acts_as_audited</tt> on your models:
acts_as_audited :except => [:password, :mistress]
end
-Within a web request, will automatically record the user that made the change if your controller has a <tt>current_user</tt> method.
+Within a web request, will automatically record the user that made the change if your controller has a <tt>current_user</tt> method. Comments can be added to an audit by setting model.audit_comments
+before create/update/destroy. If the :comment_required option is given to acts_as_audited,
+the save/update/destroy action will fail with add an error on model.audit_comment and triggering a
+transaction rollback if model.audit_comment is nil.
To record a user in the audits outside of a web request, you can use <tt>as_user</tt>:
Please sign in to comment.
Something went wrong with that request. Please try again.