Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 76 lines (47 sloc) 1.936 kb
1b63fb3 @laserlemon Start writing new README
laserlemon authored
1 Audited [![Build Status](https://secure.travis-ci.org/collectiveidea/audited.png)](http://travis-ci.org/collectiveidea/audited) [![Dependency Status](https://gemnasium.com/collectiveidea/audited.png)](https://gemnasium.com/collectiveidea/audited)
2 =======
3
4 **Audited** (previously acts_as_audited) is an ORM extension that logs all changes to your models. Audited also allows you to record who made those changes, save comments and associate models related to the changes. Audited works with Rails 3.
5
6 ## Supported Rubies
7
8 Audited supports and is [tested against](http://travis-ci.org/collectiveidea/audited) the following Ruby versions:
9
10 * 1.8.7
11 * 1.9.2
12 * 1.9.3
13 * Head
14
15 Audited may work just fine with a Ruby version not listed above, but we can't guarantee that it will. If you'd like to maintain a Ruby that isn't listed, please let us know with a [pull request](https://github.com/collectiveidea/audited/pulls).
16
17 ## Supported ORMs
18
19 In a previous life, Audited was ActiveRecord-only. Audited will now audit models for the following backends:
20
21 * ActiveRecord
22 * MongoMapper
23
24 ## Installation
25
26 The installation process depends on what ORM your app is using.
27
28 ### ActiveRecord
29
30 Add the appropriate gem to your Gemfile:
31
32 ```ruby
33 gem "audited-activerecord", "~> 3.0"
34 ```
35
36 Then, from your Rails app directory, create the `audits` table:
37
38 ```bash
39 $ rails generate audited:install
40 $ rake db:migrate
41 ```
42
43 ### MongoMapper
44
45 ```ruby
46 gem "audited-mongo_mapper", "~> 3.0"
47 ```
48
49 ## Upgrading
50
51 If you're already using Audited (or acts_as_audited), your `audits` table may require additional columns. After every upgrade, please run:
52
53 ```bash
54 $ rails generate audited:upgrade
55 ```
56
57 This will only make changes if changes are needed.
58
59 ## Usage
60
61 Simply call `audited` on your models:
62
63 ```ruby
64 class User < ActiveRecord::Base
65 audited
66 end
67 ```
68
69 ## TODO: Moar Usage
70
71 ## TODO: Caveats?
72
73 ## TODO: Support (documentation and Google group)
74
75 ## TODO: Contributing
Something went wrong with that request. Please try again.