Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updated readme with rdoc info and reformatted prettier.

  • Loading branch information...
commit 65e27195fd3f73787efd700aae6893889332fb94 1 parent 4903ecb
@jnunemaker authored
Showing with 12 additions and 11 deletions.
  1. +12 −11 README
View
23 README
@@ -1,5 +1,4 @@
-UserStamp
-=========
+= UserStamp
Rails plugin that makes stamping records with a user when they are
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
has two attributes--creator_id and updater_id. You can override both
of these assumptions easily.
-Setup
-=====
+== Setup
1. script/plugin install git://github.com/jnunemaker/user_stamp.git
2. Add user_stamp to application.rb, like the following:
@@ -18,19 +16,22 @@ Setup
end
-Defaults
-========
-UserStamp.creator_attribute = :creator_id
-UserStamp.updater_attribute = :updater_id
-UserStamp.current_user_method = :current_user
+== Defaults
+
+ UserStamp.creator_attribute = :creator_id
+ UserStamp.updater_attribute = :updater_id
+ UserStamp.current_user_method = :current_user
If your user stamped columns and current_user method are different,
just create an initializer such as config/initializers/user_stamp.rb
and copy and paste the defaults above, changing them to fit your app.
-Problems?
-=========
+== Problems?
Use the issue tracker on Github.
+== Docs
+
+http://rdoc.info/projects/jnunemaker/user_stamp
+
Copyright (c) 2008 [John Nunemaker], released under the MIT license
Please sign in to comment.
Something went wrong with that request. Please try again.