Skip to content
This repository
Browse code

updated readme with rdoc info and reformatted prettier.

  • Loading branch information...
commit 65e27195fd3f73787efd700aae6893889332fb94 1 parent 4903ecb
John Nunemaker authored

Showing 1 changed file with 12 additions and 11 deletions. Show diff stats Hide diff stats

  1. +12 11 README
23 README
... ... @@ -1,5 +1,4 @@
1   -UserStamp
2   -=========
  1 += UserStamp
3 2
4 3 Rails plugin that makes stamping records with a user when they are
5 4 created and updated dirt simple. It assumes that your controller has
@@ -7,8 +6,7 @@ a current_user method. It also assumes that any record being stamped
7 6 has two attributes--creator_id and updater_id. You can override both
8 7 of these assumptions easily.
9 8
10   -Setup
11   -=====
  9 +== Setup
12 10
13 11 1. script/plugin install git://github.com/jnunemaker/user_stamp.git
14 12 2. Add user_stamp to application.rb, like the following:
@@ -18,19 +16,22 @@ Setup
18 16 end
19 17
20 18
21   -Defaults
22   -========
23   -UserStamp.creator_attribute = :creator_id
24   -UserStamp.updater_attribute = :updater_id
25   -UserStamp.current_user_method = :current_user
  19 +== Defaults
  20 +
  21 + UserStamp.creator_attribute = :creator_id
  22 + UserStamp.updater_attribute = :updater_id
  23 + UserStamp.current_user_method = :current_user
26 24
27 25 If your user stamped columns and current_user method are different,
28 26 just create an initializer such as config/initializers/user_stamp.rb
29 27 and copy and paste the defaults above, changing them to fit your app.
30 28
31   -Problems?
32   -=========
  29 +== Problems?
33 30
34 31 Use the issue tracker on Github.
35 32
  33 +== Docs
  34 +
  35 +http://rdoc.info/projects/jnunemaker/user_stamp
  36 +
36 37 Copyright (c) 2008 [John Nunemaker], released under the MIT license

0 comments on commit 65e2719

Please sign in to comment.
Something went wrong with that request. Please try again.